Coverage Report

Created: 2026-06-16 07:20

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
0
zip_source_t *zip_source_pkware_encode(zip_t *za, zip_source_t *src, zip_uint16_t em, int flags, const char *password) {
57
0
    struct trad_pkware *ctx;
58
0
    zip_source_t *s2;
59
60
0
    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
0
    if (!(flags & ZIP_CODEC_ENCODE)) {
65
0
        zip_error_set(&za->error, ZIP_ER_ENCRNOTSUPP, 0);
66
0
        return NULL;
67
0
    }
68
69
0
    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
0
    if (zip_source_get_dos_time(src, &ctx->dostime) <= 0) {
75
0
        zip_stat_t st;
76
77
0
        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
0
        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
0
    }
87
88
0
    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
0
    return s2;
94
0
}
95
96
97
0
static int encrypt_header(zip_source_t *src, struct trad_pkware *ctx) {
98
0
    zip_uint8_t *header;
99
100
0
    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
0
    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
0
    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
0
    header[ZIP_CRYPTO_PKWARE_HEADERLEN - 1] = (zip_uint8_t)((ctx->dostime.time >> 8) & 0xff);
116
117
0
    _zip_pkware_encrypt(&ctx->keys, header, header, ZIP_CRYPTO_PKWARE_HEADERLEN);
118
119
0
    return 0;
120
0
}
121
122
123
0
static zip_int64_t pkware_encrypt(zip_source_t *src, void *ud, void *data, zip_uint64_t length, zip_source_cmd_t cmd) {
124
0
    struct trad_pkware *ctx;
125
0
    zip_int64_t n;
126
0
    zip_uint64_t buffer_n;
127
128
0
    ctx = (struct trad_pkware *)ud;
129
130
0
    switch (cmd) {
131
0
    case ZIP_SOURCE_OPEN:
132
0
        ctx->eof = false;
133
134
        /* initialize keys */
135
0
        _zip_pkware_keys_reset(&ctx->keys);
136
0
        _zip_pkware_encrypt(&ctx->keys, NULL, (const zip_uint8_t *)ctx->password, strlen(ctx->password));
137
138
0
        if (encrypt_header(src, ctx) < 0) {
139
0
            return -1;
140
0
        }
141
0
        return 0;
142
143
0
    case ZIP_SOURCE_READ:
144
0
        buffer_n = 0;
145
146
0
        if (ctx->buffer) {
147
            /* write header values to data */
148
0
            buffer_n = _zip_buffer_read(ctx->buffer, data, length);
149
0
            data = (zip_uint8_t *)data + buffer_n;
150
0
            length -= buffer_n;
151
152
0
            if (_zip_buffer_eof(ctx->buffer)) {
153
0
                _zip_buffer_free(ctx->buffer);
154
0
                ctx->buffer = NULL;
155
0
            }
156
0
        }
157
158
0
        if (ctx->eof) {
159
0
            return (zip_int64_t)buffer_n;
160
0
        }
161
162
0
        if ((n = zip_source_read(src, data, length)) < 0) {
163
0
            zip_error_set_from_source(&ctx->error, src);
164
0
            return -1;
165
0
        }
166
167
0
        _zip_pkware_encrypt(&ctx->keys, (zip_uint8_t *)data, (zip_uint8_t *)data, (zip_uint64_t)n);
168
169
0
        if ((zip_uint64_t)n < length) {
170
0
            ctx->eof = true;
171
0
        }
172
173
0
        return (zip_int64_t)buffer_n + n;
174
175
0
    case ZIP_SOURCE_CLOSE:
176
0
        _zip_buffer_free(ctx->buffer);
177
0
        ctx->buffer = NULL;
178
0
        return 0;
179
180
0
    case ZIP_SOURCE_STAT: {
181
0
        zip_stat_t *st;
182
183
0
        st = (zip_stat_t *)data;
184
0
        st->encryption_method = ZIP_EM_TRAD_PKWARE;
185
0
        st->valid |= ZIP_STAT_ENCRYPTION_METHOD;
186
0
        if (st->valid & ZIP_STAT_COMP_SIZE) {
187
0
            st->comp_size += ZIP_CRYPTO_PKWARE_HEADERLEN;
188
0
        }
189
190
0
        return 0;
191
0
    }
192
193
0
    case ZIP_SOURCE_GET_FILE_ATTRIBUTES: {
194
0
        zip_file_attributes_t *attributes = (zip_file_attributes_t *)data;
195
0
        if (length < sizeof(*attributes)) {
196
0
            zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
197
0
            return -1;
198
0
        }
199
0
        attributes->valid |= ZIP_FILE_ATTRIBUTES_VERSION_NEEDED | ZIP_FILE_ATTRIBUTES_GENERAL_PURPOSE_BIT_FLAGS;
200
0
        attributes->version_needed = 20;
201
0
        attributes->general_purpose_bit_flags = ZIP_GPBF_DATA_DESCRIPTOR;
202
0
        attributes->general_purpose_bit_mask = ZIP_GPBF_DATA_DESCRIPTOR;
203
204
0
        return 0;
205
0
    }
206
207
0
    case ZIP_SOURCE_GET_DOS_TIME:
208
0
        if (length < sizeof(ctx->dostime)) {
209
0
            zip_error_set(&ctx->error, ZIP_ER_INVAL, 0);
210
0
            return -1;
211
0
        }
212
0
        (void)memcpy_s(data, sizeof(ctx->dostime), &ctx->dostime, sizeof(ctx->dostime));
213
0
        return sizeof(ctx->dostime);
214
215
0
    case ZIP_SOURCE_SUPPORTS:
216
0
        return zip_source_make_command_bitmap(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);
217
218
0
    case ZIP_SOURCE_ERROR:
219
0
        return zip_error_to_data(&ctx->error, data, length);
220
221
0
    case ZIP_SOURCE_FREE:
222
0
        trad_pkware_free(ctx);
223
0
        return 0;
224
225
0
    default:
226
0
        return zip_source_pass_to_lower_layer(src, data, length, cmd);
227
0
    }
228
0
}
229
230
231
0
static struct trad_pkware *trad_pkware_new(const char *password, zip_error_t *error) {
232
0
    struct trad_pkware *ctx;
233
234
0
    if ((ctx = (struct trad_pkware *)malloc(sizeof(*ctx))) == NULL) {
235
0
        zip_error_set(error, ZIP_ER_MEMORY, 0);
236
0
        return NULL;
237
0
    }
238
239
0
    if ((ctx->password = strdup(password)) == NULL) {
240
0
        zip_error_set(error, ZIP_ER_MEMORY, 0);
241
0
        free(ctx);
242
0
        return NULL;
243
0
    }
244
0
    ctx->buffer = NULL;
245
0
    zip_error_init(&ctx->error);
246
247
0
    return ctx;
248
0
}
249
250
251
0
static void trad_pkware_free(struct trad_pkware *ctx) {
252
0
    if (ctx == NULL) {
253
0
        return;
254
0
    }
255
256
0
    _zip_crypto_clear(ctx->password, strlen(ctx->password));
257
0
    free(ctx->password);
258
0
    _zip_buffer_free(ctx->buffer);
259
0
    zip_error_fini(&ctx->error);
260
0
    free(ctx);
261
0
}