Coverage Report

Created: 2026-08-14 06:47

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/libzip/lib/zip_source_pkware_encode.c
Line
Count
Source
1
/*
2
  zip_source_pkware_encode.c -- Traditional PKWARE encryption routines
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
#include "zipint.h"
35
36
#include "zip_random.h"
37
38
#include <stdlib.h>
39
#include <string.h>
40
41
struct trad_pkware {
42
    char *password;
43
    zip_pkware_keys_t keys;
44
    zip_buffer_t *buffer;
45
    bool eof;
46
    zip_dostime_t dostime;
47
    zip_error_t error;
48
};
49
50
51
static int encrypt_header(zip_source_t *, struct trad_pkware *);
52
static zip_int64_t pkware_encrypt(zip_source_t *, void *, void *, zip_uint64_t, zip_source_cmd_t);
53
static void trad_pkware_free(struct trad_pkware *);
54
static struct trad_pkware *trad_pkware_new(const char *password, zip_error_t *error);
55
56
1.34k
zip_source_t *zip_source_pkware_encode(zip_t *za, zip_source_t *src, zip_uint16_t em, int flags, const char *password) {
57
1.34k
    struct trad_pkware *ctx;
58
1.34k
    zip_source_t *s2;
59
60
1.34k
    if (password == NULL || src == NULL || em != ZIP_EM_TRAD_PKWARE) {
61
0
        zip_error_set(&za->error, ZIP_ER_INVAL, 0);
62
0
        return NULL;
63
0
    }
64
1.34k
    if (!(flags & ZIP_CODEC_ENCODE)) {
65
0
        zip_error_set(&za->error, ZIP_ER_ENCRNOTSUPP, 0);
66
0
        return NULL;
67
0
    }
68
69
1.34k
    if ((ctx = trad_pkware_new(password, &za->error)) == NULL) {
70
0
        zip_error_set(&za->error, ZIP_ER_MEMORY, 0);
71
0
        return NULL;
72
0
    }
73
74
1.34k
    if (zip_source_get_dos_time(src, &ctx->dostime) <= 0) {
75
1.34k
        zip_stat_t st;
76
77
1.34k
        if (zip_source_stat(src, &st) < 0) {
78
0
            zip_error_set_from_source(&za->error, src);
79
0
            trad_pkware_free(ctx);
80
0
            return NULL;
81
0
        }
82
1.34k
        if (_zip_u2d_time((st.valid & ZIP_STAT_MTIME) ? st.mtime : time(NULL), &ctx->dostime, &za->error) < 0) {
83
0
            trad_pkware_free(ctx);
84
0
            return NULL;
85
0
        }
86
1.34k
    }
87
88
1.34k
    if ((s2 = zip_source_layered(za, src, pkware_encrypt, ctx)) == NULL) {
89
0
        trad_pkware_free(ctx);
90
0
        return NULL;
91
0
    }
92
93
1.34k
    return s2;
94
1.34k
}
95
96
97
1.34k
static int encrypt_header(zip_source_t *src, struct trad_pkware *ctx) {
98
1.34k
    zip_uint8_t *header;
99
100
1.34k
    if ((ctx->buffer = _zip_buffer_new(NULL, ZIP_CRYPTO_PKWARE_HEADERLEN)) == NULL) {
101
0
        zip_error_set(&ctx->error, ZIP_ER_MEMORY, 0);
102
0
        return -1;
103
0
    }
104
105
1.34k
    header = _zip_buffer_data(ctx->buffer);
106
107
    /* generate header from random bytes and mtime
108
       see appnote.iz, XIII. Decryption, Step 2, last paragraph */
109
1.34k
    if (!zip_secure_random(header, ZIP_CRYPTO_PKWARE_HEADERLEN - 1)) {
110
0
        zip_error_set(&ctx->error, ZIP_ER_INTERNAL, 0);
111
0
        _zip_buffer_free(ctx->buffer);
112
0
        ctx->buffer = NULL;
113
0
        return -1;
114
0
    }
115
1.34k
    header[ZIP_CRYPTO_PKWARE_HEADERLEN - 1] = (zip_uint8_t)((ctx->dostime.time >> 8) & 0xff);
116
117
1.34k
    _zip_pkware_encrypt(&ctx->keys, header, header, ZIP_CRYPTO_PKWARE_HEADERLEN);
118
119
1.34k
    return 0;
120
1.34k
}
121
122
123
12.0k
static zip_int64_t pkware_encrypt(zip_source_t *src, void *ud, void *data, zip_uint64_t length, zip_source_cmd_t cmd) {
124
12.0k
    struct trad_pkware *ctx;
125
12.0k
    zip_int64_t n;
126
12.0k
    zip_uint64_t buffer_n;
127
128
12.0k
    ctx = (struct trad_pkware *)ud;
129
130
12.0k
    switch (cmd) {
131
0
    case ZIP_SOURCE_AT_EOF:
132
0
        return ctx->eof;
133
134
1.34k
    case ZIP_SOURCE_OPEN:
135
1.34k
        ctx->eof = false;
136
137
        /* initialize keys */
138
1.34k
        _zip_pkware_keys_reset(&ctx->keys);
139
1.34k
        _zip_pkware_encrypt(&ctx->keys, NULL, (const zip_uint8_t *)ctx->password, strlen(ctx->password));
140
141
1.34k
        if (encrypt_header(src, ctx) < 0) {
142
0
            return -1;
143
0
        }
144
1.34k
        return 0;
145
146
2.68k
    case ZIP_SOURCE_READ:
147
2.68k
        buffer_n = 0;
148
149
2.68k
        if (ctx->buffer) {
150
            /* write header values to data */
151
1.34k
            buffer_n = _zip_buffer_read(ctx->buffer, data, length);
152
1.34k
            data = (zip_uint8_t *)data + buffer_n;
153
1.34k
            length -= buffer_n;
154
155
1.34k
            if (_zip_buffer_eof(ctx->buffer)) {
156
1.34k
                _zip_buffer_free(ctx->buffer);
157
1.34k
                ctx->buffer = NULL;
158
1.34k
            }
159
1.34k
        }
160
161
2.68k
        if (ctx->eof) {
162
1.34k
            return (zip_int64_t)buffer_n;
163
1.34k
        }
164
165
1.34k
        if ((n = zip_source_read(src, data, length)) < 0) {
166
0
            zip_error_set_from_source(&ctx->error, src);
167
0
            return -1;
168
0
        }
169
170
1.34k
        _zip_pkware_encrypt(&ctx->keys, (zip_uint8_t *)data, (zip_uint8_t *)data, (zip_uint64_t)n);
171
172
1.34k
        if ((zip_uint64_t)n < length) {
173
1.34k
            ctx->eof = true;
174
1.34k
        }
175
176
1.34k
        return (zip_int64_t)buffer_n + n;
177
178
1.34k
    case ZIP_SOURCE_CLOSE:
179
1.34k
        _zip_buffer_free(ctx->buffer);
180
1.34k
        ctx->buffer = NULL;
181
1.34k
        return 0;
182
183
1.34k
    case ZIP_SOURCE_STAT: {
184
1.34k
        zip_stat_t *st;
185
186
1.34k
        st = (zip_stat_t *)data;
187
1.34k
        st->encryption_method = ZIP_EM_TRAD_PKWARE;
188
1.34k
        st->valid |= ZIP_STAT_ENCRYPTION_METHOD;
189
1.34k
        if (st->valid & ZIP_STAT_COMP_SIZE) {
190
1.34k
            st->comp_size += ZIP_CRYPTO_PKWARE_HEADERLEN;
191
1.34k
        }
192
193
1.34k
        return 0;
194
1.34k
    }
195
196
2.68k
    case ZIP_SOURCE_GET_FILE_ATTRIBUTES: {
197
2.68k
        zip_file_attributes_t *attributes = (zip_file_attributes_t *)data;
198
2.68k
        if (length < sizeof(*attributes)) {
199
0
            zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
200
0
            return -1;
201
0
        }
202
2.68k
        attributes->valid |= ZIP_FILE_ATTRIBUTES_VERSION_NEEDED | ZIP_FILE_ATTRIBUTES_GENERAL_PURPOSE_BIT_FLAGS;
203
2.68k
        attributes->version_needed = 20;
204
2.68k
        attributes->general_purpose_bit_flags = ZIP_GPBF_DATA_DESCRIPTOR;
205
2.68k
        attributes->general_purpose_bit_mask = ZIP_GPBF_DATA_DESCRIPTOR;
206
207
2.68k
        return 0;
208
2.68k
    }
209
210
0
    case ZIP_SOURCE_GET_DOS_TIME:
211
0
        if (length < sizeof(ctx->dostime)) {
212
0
            zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
213
0
            return -1;
214
0
        }
215
0
        (void)memcpy_s(data, sizeof(ctx->dostime), &ctx->dostime, sizeof(ctx->dostime));
216
0
        return sizeof(ctx->dostime);
217
218
1.34k
    case ZIP_SOURCE_SUPPORTS:
219
1.34k
        return zip_source_make_command_bitmap(ZIP_SOURCE_AT_EOF, ZIP_SOURCE_OPEN, ZIP_SOURCE_READ, ZIP_SOURCE_CLOSE, ZIP_SOURCE_STAT, ZIP_SOURCE_ERROR, ZIP_SOURCE_FREE, ZIP_SOURCE_GET_FILE_ATTRIBUTES, ZIP_SOURCE_GET_DOS_TIME, -1);
220
221
0
    case ZIP_SOURCE_ERROR:
222
0
        return zip_error_to_data(&ctx->error, data, length);
223
224
1.34k
    case ZIP_SOURCE_FREE:
225
1.34k
        trad_pkware_free(ctx);
226
1.34k
        return 0;
227
228
0
    default:
229
0
        return zip_source_pass_to_lower_layer(src, data, length, cmd);
230
12.0k
    }
231
12.0k
}
232
233
234
1.34k
static struct trad_pkware *trad_pkware_new(const char *password, zip_error_t *error) {
235
1.34k
    struct trad_pkware *ctx;
236
237
1.34k
    if ((ctx = (struct trad_pkware *)malloc(sizeof(*ctx))) == NULL) {
238
0
        zip_error_set(error, ZIP_ER_MEMORY, 0);
239
0
        return NULL;
240
0
    }
241
242
1.34k
    if ((ctx->password = strdup(password)) == NULL) {
243
0
        zip_error_set(error, ZIP_ER_MEMORY, 0);
244
0
        free(ctx);
245
0
        return NULL;
246
0
    }
247
1.34k
    ctx->buffer = NULL;
248
1.34k
    zip_error_init(&ctx->error);
249
250
1.34k
    return ctx;
251
1.34k
}
252
253
254
1.34k
static void trad_pkware_free(struct trad_pkware *ctx) {
255
1.34k
    if (ctx == NULL) {
256
0
        return;
257
0
    }
258
259
1.34k
    _zip_crypto_clear(ctx->password, strlen(ctx->password));
260
1.34k
    free(ctx->password);
261
1.34k
    _zip_buffer_free(ctx->buffer);
262
1.34k
    zip_error_fini(&ctx->error);
263
1.34k
    free(ctx);
264
1.34k
}