Coverage Report

Created: 2026-10-14 06:52

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libzip/lib/zip_source_crc.c
Line
Count
Source
1
/*
2
  zip_source_crc.c -- pass-through source that calculates CRC32 and size
3
  Copyright (C) 2009-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
35
#include <limits.h>
36
#include <stdlib.h>
37
#include <zlib.h>
38
39
#include "zipint.h"
40
41
struct crc_context {
42
    int validate;     /* whether to check CRC on EOF and return error on mismatch */
43
    int crc_complete; /* whether CRC was computed for complete file */
44
    zip_error_t error;
45
    zip_uint64_t size;
46
    zip_uint64_t position;     /* current reading position */
47
    zip_uint64_t crc_position; /* how far we've computed the CRC */
48
    zip_uint32_t crc;
49
};
50
51
static void crc_context_free(struct crc_context *ctx);
52
static struct crc_context *crc_context_new(void);
53
static void crc_context_read_init(struct crc_context *ctx);
54
static zip_int64_t crc_read(zip_source_t *, void *, void *, zip_uint64_t, zip_source_cmd_t);
55
static zip_int64_t validate_crc(struct crc_context *ctx, zip_source_t *src);
56
57
9.35k
zip_source_t *zip_source_crc_create(zip_source_t *src, int validate, zip_error_t *error) {
58
9.35k
    struct crc_context *ctx;
59
9.35k
    zip_source_t *new_src;
60
61
9.35k
    if (src == NULL) {
62
0
        zip_error_set(error, ZIP_ER_INVAL, 0);
63
0
        return NULL;
64
0
    }
65
66
9.35k
    if ((ctx = crc_context_new()) == NULL) {
67
0
        zip_error_set(error, ZIP_ER_MEMORY, 0);
68
0
        return NULL;
69
0
    }
70
9.35k
    ctx->validate = validate;
71
72
9.35k
    new_src = zip_source_layered_create(src, crc_read, ctx, error);
73
9.35k
    if (new_src == NULL) {
74
0
        crc_context_free(ctx);
75
0
        return NULL;
76
0
    }
77
9.35k
    return new_src;
78
9.35k
}
79
80
81
55.4k
static zip_int64_t crc_read(zip_source_t *src, void *_ctx, void *data, zip_uint64_t len, zip_source_cmd_t cmd) {
82
55.4k
    struct crc_context *ctx;
83
55.4k
    zip_int64_t n;
84
85
55.4k
    ctx = (struct crc_context *)_ctx;
86
87
55.4k
    switch (cmd) {
88
8.45k
    case ZIP_SOURCE_OPEN:
89
8.45k
        crc_context_read_init(ctx);
90
8.45k
        return 0;
91
92
10.7k
    case ZIP_SOURCE_READ:
93
10.7k
        if ((n = zip_source_read(src, data, len)) < 0) {
94
1.55k
            zip_error_set_from_source(&ctx->error, src);
95
1.55k
            return -1;
96
1.55k
        }
97
98
9.18k
        if (n == 0) {
99
2.35k
            return validate_crc(ctx, src);
100
2.35k
        }
101
6.83k
        else {
102
            /*
103
             We can only compute the CRC data in the correct order. So we update the CRC for data read this time that starts at ctx->crc_position.
104
105
             If we already computed the CRC for the whole file, or if there is a gap between ctx->crc_position and the start of new data, or if we already computed the CRC for all new data read, we don't update the CRC.
106
107
             ctx->position is the position of the first byte in data.
108
109
             ctx->crc_position is the position of the first byte in data that has not been included  in the CRC yet.
110
111
             Therefore, we want to compute the CRC for data[ctx->crc_position - ctx->position .. n-1].
112
113
            */
114
6.83k
            if (!ctx->crc_complete && ctx->position <= ctx->crc_position && ctx->crc_position < ctx->position + (zip_uint64_t)n) {
115
6.83k
                zip_uint64_t i, nn;
116
117
13.6k
                for (i = ctx->crc_position - ctx->position; i < (zip_uint64_t)n; i += nn) {
118
6.83k
                    nn = ZIP_MIN(UINT_MAX, (zip_uint64_t)n - i);
119
120
6.83k
                    ctx->crc = (zip_uint32_t)crc32(ctx->crc, (const Bytef *)data + i, (uInt)nn);
121
6.83k
                    ctx->crc_position += nn;
122
6.83k
                }
123
6.83k
            }
124
6.83k
        }
125
6.83k
        ctx->position += (zip_uint64_t)n;
126
6.83k
        return n;
127
128
8.45k
    case ZIP_SOURCE_CLOSE: {
129
8.45k
        zip_int64_t ret = zip_source_at_eof(src);
130
8.45k
        if (ret < 0) {
131
1.43k
            zip_error_set_from_source(&ctx->error, src);
132
1.43k
            return -1;
133
1.43k
        }
134
7.02k
        else if (ret == 1) {
135
5.86k
            return validate_crc(ctx, src);
136
5.86k
        }
137
1.15k
        else {
138
1.15k
            return 0;
139
1.15k
        }
140
8.45k
    }
141
142
0
    case ZIP_SOURCE_STAT: {
143
0
        zip_stat_t *st;
144
145
0
        st = (zip_stat_t *)data;
146
147
0
        if (ctx->crc_complete) {
148
0
            if ((st->valid & ZIP_STAT_SIZE) && st->size != ctx->size) {
149
0
                zip_error_set(&ctx->error, ZIP_ER_DATA_LENGTH, 0);
150
0
                return -1;
151
0
            }
152
            /* TODO: Set comp_size, comp_method, encryption_method?
153
                    After all, this only works for uncompressed data. */
154
0
            st->size = ctx->size;
155
0
            st->crc = ctx->crc;
156
0
            st->comp_size = ctx->size;
157
0
            st->comp_method = ZIP_CM_STORE;
158
0
            st->encryption_method = ZIP_EM_NONE;
159
0
            st->valid |= ZIP_STAT_SIZE | ZIP_STAT_CRC | ZIP_STAT_COMP_SIZE | ZIP_STAT_COMP_METHOD | ZIP_STAT_ENCRYPTION_METHOD;
160
0
        }
161
0
        return 0;
162
0
    }
163
164
9.11k
    case ZIP_SOURCE_ERROR:
165
9.11k
        return zip_error_to_data(&ctx->error, data, len);
166
167
9.35k
    case ZIP_SOURCE_FREE:
168
9.35k
        crc_context_free(ctx);
169
9.35k
        return 0;
170
171
9.35k
    case ZIP_SOURCE_SUPPORTS: {
172
9.35k
        zip_int64_t mask = zip_source_supports(src);
173
174
9.35k
        if (mask < 0) {
175
0
            zip_error_set_from_source(&ctx->error, src);
176
0
            return -1;
177
0
        }
178
179
9.35k
        mask &= ~zip_source_make_command_bitmap(ZIP_SOURCE_BEGIN_WRITE, ZIP_SOURCE_COMMIT_WRITE, ZIP_SOURCE_ROLLBACK_WRITE, ZIP_SOURCE_SEEK_WRITE, ZIP_SOURCE_TELL_WRITE, ZIP_SOURCE_REMOVE, ZIP_SOURCE_GET_FILE_ATTRIBUTES, -1);
180
9.35k
        mask |= zip_source_make_command_bitmap(ZIP_SOURCE_FREE, -1);
181
9.35k
        return mask;
182
9.35k
    }
183
184
0
    case ZIP_SOURCE_SEEK: {
185
0
        zip_int64_t new_position;
186
0
        zip_source_args_seek_t *args = ZIP_SOURCE_GET_ARGS(zip_source_args_seek_t, data, len, &ctx->error);
187
188
0
        if (args == NULL) {
189
0
            return -1;
190
0
        }
191
0
        if (zip_source_seek(src, args->offset, args->whence) < 0 || (new_position = zip_source_tell(src)) < 0) {
192
0
            zip_error_set_from_source(&ctx->error, src);
193
0
            return -1;
194
0
        }
195
196
0
        ctx->position = (zip_uint64_t)new_position;
197
198
0
        return 0;
199
0
    }
200
201
0
    case ZIP_SOURCE_TELL:
202
0
        return (zip_int64_t)ctx->position;
203
204
0
    default:
205
0
        return zip_source_pass_to_lower_layer(src, data, len, cmd);
206
55.4k
    }
207
55.4k
}
208
209
8.21k
zip_int64_t validate_crc(struct crc_context *ctx, zip_source_t *src) {
210
8.21k
    struct zip_stat st;
211
212
8.21k
    ctx->size = ctx->position;
213
214
8.21k
    if (ctx->validate) {
215
8.21k
        if (zip_source_stat(src, &st) < 0) {
216
0
            zip_error_set_from_source(&ctx->error, src);
217
0
            return -1;
218
0
        }
219
8.21k
    }
220
221
8.21k
    if (ctx->crc_position == ctx->position) {
222
8.21k
        ctx->crc_complete = 1;
223
224
8.21k
        if (ctx->validate) {
225
8.21k
            if ((st.valid & ZIP_STAT_CRC) && st.crc != ctx->crc) {
226
5.99k
                zip_error_set(&ctx->error, ZIP_ER_CRC, 0);
227
5.99k
                return -1;
228
5.99k
            }
229
8.21k
        }
230
8.21k
    }
231
232
2.22k
    if (ctx->validate) {
233
2.22k
        if ((st.valid & ZIP_STAT_SIZE) && st.size != ctx->size) {
234
            /* We don't have the index here, but the caller should know which file they are reading from. */
235
138
            zip_error_set(&ctx->error, ZIP_ER_INCONS, MAKE_DETAIL_WITH_INDEX(ZIP_ER_DETAIL_INVALID_FILE_LENGTH, MAX_DETAIL_INDEX));
236
138
            return -1;
237
138
        }
238
2.22k
    }
239
240
2.08k
    return 0;
241
2.22k
}
242
243
9.35k
static struct crc_context *crc_context_new(void) {
244
9.35k
    struct crc_context *ctx;
245
246
9.35k
    if ((ctx = (struct crc_context *)malloc(sizeof(*ctx))) == NULL) {
247
0
        return NULL;
248
0
    }
249
250
9.35k
    zip_error_init(&ctx->error);
251
9.35k
    ctx->validate = 0;
252
9.35k
    crc_context_read_init(ctx);
253
254
9.35k
    return ctx;
255
9.35k
}
256
257
9.35k
static void crc_context_free(struct crc_context *ctx) {
258
9.35k
    if (ctx == NULL) {
259
0
        return;
260
0
    }
261
262
9.35k
    zip_error_fini(&ctx->error);
263
9.35k
    free(ctx);
264
9.35k
}
265
266
17.8k
static void crc_context_read_init(struct crc_context *ctx) {
267
17.8k
    ctx->position = 0;
268
17.8k
    ctx->crc_complete = 0;
269
17.8k
    ctx->crc_position = 0;
270
    ctx->crc = (zip_uint32_t)crc32(0, NULL, 0);
271
17.8k
    ctx->size = 0;
272
17.8k
}