Coverage Report

Created: 2025-07-23 08:18

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