Coverage Report

Created: 2026-04-01 07:49

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libzip/lib/zip_source_window.c
Line
Count
Source
1
/*
2
  zip_source_window.c -- return part of lower source
3
  Copyright (C) 2012-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 window {
40
    zip_uint64_t start; /* where in file we start reading */
41
    zip_uint64_t end;   /* where in file we stop reading */
42
    bool end_valid;     /* whether end is set, otherwise read until EOF */
43
44
    /* if not NULL, read file data for this file */
45
    zip_t *source_archive;
46
    zip_uint64_t source_index;
47
48
    zip_uint64_t offset; /* offset in src for next read */
49
50
    zip_stat_t stat;
51
    zip_uint64_t stat_invalid;
52
    zip_file_attributes_t attributes;
53
    zip_dostime_t dostime;
54
    bool dostime_valid;
55
    zip_error_t error;
56
    zip_int64_t supports;
57
    bool needs_seek;
58
};
59
60
static zip_int64_t window_read(zip_source_t *, void *, void *, zip_uint64_t, zip_source_cmd_t);
61
62
63
0
ZIP_EXTERN zip_source_t *zip_source_window_create(zip_source_t *src, zip_uint64_t start, zip_int64_t len, zip_error_t *error) {
64
0
    return _zip_source_window_new(src, start, len, NULL, 0, NULL, NULL, NULL, 0, false, error);
65
0
}
66
67
68
0
zip_source_t *_zip_source_window_new(zip_source_t *src, zip_uint64_t start, zip_int64_t length, zip_stat_t *st, zip_uint64_t st_invalid, zip_file_attributes_t *attributes, zip_dostime_t *dostime, zip_t *source_archive, zip_uint64_t source_index, bool take_ownership, zip_error_t *error) {
69
0
    zip_source_t *window_source;
70
0
    struct window *ctx;
71
72
0
    if (src == NULL || length < -1 || (source_archive == NULL && source_index != 0)) {
73
0
        zip_error_set(error, ZIP_ER_INVAL, 0);
74
0
        return NULL;
75
0
    }
76
77
0
    if (length >= 0) {
78
0
        if (start + (zip_uint64_t)length < start) {
79
0
            zip_error_set(error, ZIP_ER_INVAL, 0);
80
0
            return NULL;
81
0
        }
82
0
    }
83
84
0
    if ((ctx = (struct window *)malloc(sizeof(*ctx))) == NULL) {
85
0
        zip_error_set(error, ZIP_ER_MEMORY, 0);
86
0
        return NULL;
87
0
    }
88
89
0
    ctx->start = start;
90
0
    if (length == -1) {
91
0
        ctx->end_valid = false;
92
0
    }
93
0
    else {
94
0
        ctx->end = start + (zip_uint64_t)length;
95
0
        ctx->end_valid = true;
96
0
    }
97
0
    zip_stat_init(&ctx->stat);
98
0
    ctx->stat_invalid = st_invalid;
99
0
    if (attributes != NULL) {
100
0
        (void)memcpy_s(&ctx->attributes, sizeof(ctx->attributes), attributes, sizeof(ctx->attributes));
101
0
    }
102
0
    else {
103
0
        zip_file_attributes_init(&ctx->attributes);
104
0
    }
105
0
    if (dostime != NULL) {
106
0
        ctx->dostime = *dostime;
107
0
        ctx->dostime_valid = true;
108
0
    }
109
0
    else {
110
0
        ctx->dostime_valid = false;
111
0
    }
112
0
    ctx->source_archive = source_archive;
113
0
    ctx->source_index = source_index;
114
0
    zip_error_init(&ctx->error);
115
0
    ctx->supports = (zip_source_supports(src) & (ZIP_SOURCE_SUPPORTS_SEEKABLE | ZIP_SOURCE_SUPPORTS_REOPEN)) | (zip_source_make_command_bitmap(ZIP_SOURCE_GET_FILE_ATTRIBUTES, ZIP_SOURCE_GET_DOS_TIME, ZIP_SOURCE_SUPPORTS, ZIP_SOURCE_TELL, ZIP_SOURCE_FREE, -1));
116
0
    ctx->needs_seek = (ctx->supports & ZIP_SOURCE_MAKE_COMMAND_BITMASK(ZIP_SOURCE_SEEK)) ? true : false;
117
118
0
    if (st) {
119
0
        if (_zip_stat_merge(&ctx->stat, st, error) < 0) {
120
0
            free(ctx);
121
0
            return NULL;
122
0
        }
123
0
    }
124
125
0
    window_source = zip_source_layered_create(src, window_read, ctx, error);
126
0
    if (window_source == NULL) {
127
0
        free(ctx);
128
0
        return NULL;
129
0
    }
130
0
    if (!take_ownership) {
131
0
        zip_source_keep(src);
132
0
    }
133
0
    return window_source;
134
0
}
135
136
137
0
int _zip_source_set_source_archive(zip_source_t *src, zip_t *za) {
138
0
    src->source_archive = za;
139
0
    return _zip_register_source(za, src);
140
0
}
141
142
143
/* called by zip_discard to avoid operating on file from closed archive */
144
0
void _zip_source_invalidate(zip_source_t *src) {
145
0
    src->source_closed = 1;
146
147
0
    if (zip_error_code_zip(&src->error) == ZIP_ER_OK) {
148
0
        zip_error_set(&src->error, ZIP_ER_ZIPCLOSED, 0);
149
0
    }
150
0
}
151
152
153
0
static zip_int64_t window_read(zip_source_t *src, void *_ctx, void *data, zip_uint64_t len, zip_source_cmd_t cmd) {
154
0
    struct window *ctx;
155
0
    zip_int64_t ret;
156
0
    zip_uint64_t n, i;
157
158
0
    ctx = (struct window *)_ctx;
159
160
0
    switch (cmd) {
161
0
    case ZIP_SOURCE_CLOSE:
162
0
        return 0;
163
164
0
    case ZIP_SOURCE_ERROR:
165
0
        return zip_error_to_data(&ctx->error, data, len);
166
167
0
    case ZIP_SOURCE_FREE:
168
0
        free(ctx);
169
0
        return 0;
170
171
0
    case ZIP_SOURCE_OPEN:
172
0
        if (ctx->source_archive) {
173
0
            zip_uint64_t offset;
174
175
0
            if ((offset = _zip_file_get_offset(ctx->source_archive, ctx->source_index, &ctx->error)) == 0) {
176
0
                return -1;
177
0
            }
178
0
            if (ctx->end + offset < ctx->end) {
179
                /* zip archive data claims end of data past zip64 limits */
180
0
                zip_error_set(&ctx->error, ZIP_ER_INCONS, MAKE_DETAIL_WITH_INDEX(ZIP_ER_DETAIL_CDIR_ENTRY_INVALID, ctx->source_index));
181
0
                return -1;
182
0
            }
183
0
            ctx->start += offset;
184
0
            ctx->end += offset;
185
0
            ctx->source_archive = NULL;
186
0
        }
187
188
0
        if (!ctx->needs_seek) {
189
0
            DEFINE_BYTE_ARRAY(b, BUFSIZE);
190
191
0
            if (!byte_array_init(b, BUFSIZE)) {
192
0
                zip_error_set(&ctx->error, ZIP_ER_MEMORY, 0);
193
0
                return -1;
194
0
            }
195
196
0
            for (n = 0; n < ctx->start; n += (zip_uint64_t)ret) {
197
0
                i = (ctx->start - n > BUFSIZE ? BUFSIZE : ctx->start - n);
198
0
                if ((ret = zip_source_read(src, b, i)) < 0) {
199
0
                    zip_error_set_from_source(&ctx->error, src);
200
0
                    byte_array_fini(b);
201
0
                    return -1;
202
0
                }
203
0
                if (ret == 0) {
204
0
                    zip_error_set(&ctx->error, ZIP_ER_EOF, 0);
205
0
                    byte_array_fini(b);
206
0
                    return -1;
207
0
                }
208
0
            }
209
210
0
            byte_array_fini(b);
211
0
        }
212
213
0
        ctx->offset = ctx->start;
214
0
        return 0;
215
216
0
    case ZIP_SOURCE_READ:
217
0
        if (ctx->end_valid && len > ctx->end - ctx->offset) {
218
0
            len = ctx->end - ctx->offset;
219
0
        }
220
221
0
        if (len == 0) {
222
0
            return 0;
223
0
        }
224
225
0
        if (ctx->needs_seek) {
226
0
            if (zip_source_seek(src, (zip_int64_t)ctx->offset, SEEK_SET) < 0) {
227
0
                zip_error_set_from_source(&ctx->error, src);
228
0
                return -1;
229
0
            }
230
0
        }
231
232
0
        if ((ret = zip_source_read(src, data, len)) < 0) {
233
0
            zip_error_set(&ctx->error, ZIP_ER_EOF, 0);
234
0
            return -1;
235
0
        }
236
237
0
        ctx->offset += (zip_uint64_t)ret;
238
239
0
        if (ret == 0) {
240
0
            if (ctx->end_valid && ctx->offset < ctx->end) {
241
0
                zip_error_set(&ctx->error, ZIP_ER_EOF, 0);
242
0
                return -1;
243
0
            }
244
0
        }
245
0
        return ret;
246
247
0
    case ZIP_SOURCE_SEEK: {
248
0
        zip_int64_t new_offset;
249
250
0
        if (!ctx->end_valid) {
251
0
            zip_source_args_seek_t *args = ZIP_SOURCE_GET_ARGS(zip_source_args_seek_t, data, len, &ctx->error);
252
253
0
            if (args == NULL) {
254
0
                return -1;
255
0
            }
256
0
            if (args->whence == SEEK_END) {
257
0
                if (zip_source_seek(src, args->offset, args->whence) < 0) {
258
0
                    zip_error_set_from_source(&ctx->error, src);
259
0
                    return -1;
260
0
                }
261
0
                new_offset = zip_source_tell(src);
262
0
                if (new_offset < 0) {
263
0
                    zip_error_set_from_source(&ctx->error, src);
264
0
                    return -1;
265
0
                }
266
0
                if ((zip_uint64_t)new_offset < ctx->start) {
267
0
                    zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
268
0
                    (void)zip_source_seek(src, (zip_int64_t)ctx->offset, SEEK_SET);
269
0
                    return -1;
270
0
                }
271
0
                ctx->offset = (zip_uint64_t)new_offset;
272
0
                return 0;
273
0
            }
274
0
        }
275
276
0
        new_offset = zip_source_seek_compute_offset(ctx->offset - ctx->start, ctx->end - ctx->start, data, len, &ctx->error);
277
278
0
        if (new_offset < 0) {
279
0
            return -1;
280
0
        }
281
282
0
        ctx->offset = (zip_uint64_t)new_offset + ctx->start;
283
0
        return 0;
284
0
    }
285
286
0
    case ZIP_SOURCE_STAT: {
287
0
        zip_stat_t *st;
288
289
0
        st = (zip_stat_t *)data;
290
291
0
        if (_zip_stat_merge(st, &ctx->stat, &ctx->error) < 0) {
292
0
            return -1;
293
0
        }
294
295
0
        if (!(ctx->stat.valid & ZIP_STAT_SIZE)) {
296
0
            if (ctx->end_valid) {
297
0
                st->valid |= ZIP_STAT_SIZE;
298
0
                st->size = ctx->end - ctx->start;
299
0
            }
300
0
            else if (st->valid & ZIP_STAT_SIZE) {
301
0
                st->size -= ctx->start;
302
0
            }
303
0
        }
304
305
0
        st->valid &= ~ctx->stat_invalid;
306
307
0
        return 0;
308
0
    }
309
310
0
    case ZIP_SOURCE_GET_FILE_ATTRIBUTES:
311
0
        if (len < sizeof(ctx->attributes)) {
312
0
            zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
313
0
            return -1;
314
0
        }
315
316
0
        (void)memcpy_s(data, sizeof(ctx->attributes), &ctx->attributes, sizeof(ctx->attributes));
317
0
        return sizeof(ctx->attributes);
318
319
0
    case ZIP_SOURCE_GET_DOS_TIME:
320
0
        if (len < sizeof(ctx->dostime)) {
321
0
            zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
322
0
            return -1;
323
0
        }
324
0
        if (ctx->dostime_valid) {
325
0
            (void)memcpy_s(data, sizeof(ctx->dostime), &ctx->dostime, sizeof(ctx->dostime));
326
0
            return sizeof(ctx->dostime);
327
0
        }
328
0
        else {
329
0
            return 0;
330
0
        }
331
332
0
    case ZIP_SOURCE_SUPPORTS:
333
0
        return ctx->supports;
334
335
0
    case ZIP_SOURCE_TELL:
336
0
        return (zip_int64_t)(ctx->offset - ctx->start);
337
338
0
    default:
339
0
        return zip_source_pass_to_lower_layer(src, data, len, cmd);
340
0
    }
341
0
}
342
343
344
0
void _zip_deregister_source(zip_t *za, zip_source_t *src) {
345
0
    zip_uint64_t i;
346
347
0
    for (i = 0; i < za->nopen_source; i++) {
348
0
        if (za->open_source[i] == src) {
349
0
            za->open_source[i] = za->open_source[za->nopen_source - 1];
350
0
            za->nopen_source--;
351
0
            break;
352
0
        }
353
0
    }
354
0
}
355
356
357
0
int _zip_register_source(zip_t *za, zip_source_t *src) {
358
0
    if (za->nopen_source + 1 >= za->nopen_source_alloc) {
359
0
        if (!ZIP_REALLOC(za->open_source, za->nopen_source_alloc, 10, &za->error)) {
360
0
            return -1;
361
0
        }
362
0
    }
363
364
0
    za->open_source[za->nopen_source++] = src;
365
366
0
    return 0;
367
0
}