1 /*-
2 * Copyright (c) 2003-2008 Tim Kientzle
3 * Copyright (c) 2008 Anselm Strauss
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27 /*
28 * Development supported by Google Summer of Code 2008.
29 */
30
31 #include "test.h"
32
33 /*
34 * Detailed byte-for-byte verification of the format of a zip archive
35 * with a single file written to it that uses Zip64 extensions.
36 */
37
38 static unsigned long
bitcrc32(unsigned long c,void * _p,size_t s)39 bitcrc32(unsigned long c, void *_p, size_t s)
40 {
41 /* This is a drop-in replacement for crc32() from zlib.
42 * Libarchive should be able to correctly generate
43 * uncompressed zip archives (including correct CRCs) even
44 * when zlib is unavailable, and this function helps us verify
45 * that. Yes, this is very, very slow and unsuitable for
46 * production use, but it's correct, compact, and works well
47 * enough for this particular usage. Libarchive internally
48 * uses a much more efficient implementation. */
49 const unsigned char *p = _p;
50 int bitctr;
51
52 if (p == NULL)
53 return (0);
54
55 for (; s > 0; --s) {
56 c ^= *p++;
57 for (bitctr = 8; bitctr > 0; --bitctr) {
58 if (c & 1) c = (c >> 1);
59 else c = (c >> 1) ^ 0xedb88320;
60 c ^= 0x80000000;
61 }
62 }
63 return (c);
64 }
65
66 /* Quick and dirty: Read 2-byte and 4-byte integers from Zip file. */
i2(const unsigned char * p)67 static unsigned i2(const unsigned char *p) { return ((p[0] & 0xff) | ((p[1] & 0xff) << 8)); }
i4(const unsigned char * p)68 static unsigned i4(const unsigned char *p) { return (i2(p) | (i2(p + 2) << 16)); }
69 /* We're only working with small values here; ignore the 4 high bytes. */
i8(const unsigned char * p)70 static unsigned i8(const unsigned char *p) { return (i4(p)); }
71
DEFINE_TEST(test_write_format_zip_file_zip64)72 DEFINE_TEST(test_write_format_zip_file_zip64)
73 {
74 struct archive *a;
75 struct archive_entry *ae;
76 time_t t = 1234567890;
77 struct tm *tm;
78 #if defined(HAVE_LOCALTIME_R) || defined(HAVE_LOCALTIME_S)
79 struct tm tmbuf;
80 #endif
81 size_t used, buffsize = 1000000;
82 unsigned long crc;
83 int file_perm = 00644;
84 int zip_version = 45;
85 int zip_compression = 8;
86 short file_uid = 10, file_gid = 20;
87 unsigned char *buff, *buffend, *p;
88 unsigned char *central_header, *local_header, *eocd, *eocd_record;
89 unsigned char *extension_start, *extension_end;
90 char file_data[] = {'1', '2', '3', '4', '5', '6', '7', '8'};
91 const char *file_name = "file";
92
93 #ifndef HAVE_ZLIB_H
94 zip_compression = 0;
95 #endif
96
97 #if defined(HAVE_LOCALTIME_S)
98 tm = localtime_s(&tmbuf, &t) ? NULL : &tmbuf;
99 #elif defined(HAVE_LOCALTIME_R)
100 tm = localtime_r(&t, &tmbuf);
101 #else
102 tm = localtime(&t);
103 #endif
104 buff = malloc(buffsize);
105
106 /* Create a new archive in memory. */
107 assert((a = archive_write_new()) != NULL);
108 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_zip(a));
109 assertEqualIntA(a, ARCHIVE_OK,
110 archive_write_set_options(a, "zip:zip64"));
111 assertEqualIntA(a, ARCHIVE_OK,
112 archive_write_set_options(a, "zip:experimental"));
113 assertEqualIntA(a, ARCHIVE_OK,
114 archive_write_open_memory(a, buff, buffsize, &used));
115
116 assert((ae = archive_entry_new()) != NULL);
117 archive_entry_copy_pathname(ae, file_name);
118 archive_entry_set_mode(ae, AE_IFREG | file_perm);
119 archive_entry_set_size(ae, sizeof(file_data));
120 archive_entry_set_uid(ae, file_uid);
121 archive_entry_set_gid(ae, file_gid);
122 archive_entry_set_mtime(ae, t, 0);
123 assertEqualInt(0, archive_write_header(a, ae));
124 archive_entry_free(ae);
125 assertEqualInt(8, archive_write_data(a, file_data, sizeof(file_data)));
126 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a));
127 assertEqualInt(ARCHIVE_OK, archive_write_free(a));
128 buffend = buff + used;
129 dumpfile("constructed.zip", buff, used);
130
131 /* Verify "End of Central Directory" record. */
132 /* Get address of end-of-central-directory record. */
133 eocd_record = p = buffend - 22; /* Assumes there is no zip comment field. */
134 failure("End-of-central-directory begins with PK\\005\\006 signature");
135 assertEqualMem(p, "PK\005\006", 4);
136 failure("This must be disk 0");
137 assertEqualInt(i2(p + 4), 0);
138 failure("Central dir must start on disk 0");
139 assertEqualInt(i2(p + 6), 0);
140 failure("All central dir entries are on this disk");
141 assertEqualInt(i2(p + 8), i2(p + 10));
142 eocd = buff + i4(p + 12) + i4(p + 16);
143 failure("no zip comment");
144 assertEqualInt(i2(p + 20), 0);
145
146 /* Get address of first entry in central directory. */
147 central_header = p = buff + i4(buffend - 6);
148 failure("Central file record at offset %d should begin with"
149 " PK\\001\\002 signature",
150 i4(buffend - 10));
151
152 /* Verify file entry in central directory. */
153 assertEqualMem(p, "PK\001\002", 4); /* Signature */
154 assertEqualInt(i2(p + 4), 3 * 256 + zip_version); /* Version made by */
155 assertEqualInt(i2(p + 6), zip_version); /* Version needed to extract */
156 assertEqualInt(i2(p + 8), 8); /* Flags */
157 assertEqualInt(i2(p + 10), zip_compression); /* Compression method */
158 assertEqualInt(i2(p + 12), (tm->tm_hour * 2048) + (tm->tm_min * 32) + (tm->tm_sec / 2)); /* File time */
159 assertEqualInt(i2(p + 14), ((tm->tm_year - 80) * 512) + ((tm->tm_mon + 1) * 32) + tm->tm_mday); /* File date */
160 crc = bitcrc32(0, file_data, sizeof(file_data));
161 assertEqualInt(i4(p + 16), crc); /* CRC-32 */
162 /* assertEqualInt(i4(p + 20), sizeof(file_data)); */ /* Compressed size */
163 assertEqualInt(i4(p + 24), sizeof(file_data)); /* Uncompressed size */
164 assertEqualInt(i2(p + 28), strlen(file_name)); /* Pathname length */
165 /* assertEqualInt(i2(p + 30), 28); */ /* Extra field length: See below */
166 assertEqualInt(i2(p + 32), 0); /* File comment length */
167 assertEqualInt(i2(p + 34), 0); /* Disk number start */
168 assertEqualInt(i2(p + 36), 0); /* Internal file attrs */
169 assertEqualInt(i4(p + 38) >> 16 & 01777, file_perm); /* External file attrs */
170 assertEqualInt(i4(p + 42), 0); /* Offset of local header */
171 assertEqualMem(p + 46, file_name, strlen(file_name)); /* Pathname */
172 p = extension_start = central_header + 46 + strlen(file_name);
173 extension_end = extension_start + i2(central_header + 30);
174
175 assertEqualInt(i2(p), 0x7875); /* 'ux' extension header */
176 assertEqualInt(i2(p + 2), 11); /* 'ux' size */
177 /* TODO: verify 'ux' contents */
178 p += 4 + i2(p + 2);
179
180 assertEqualInt(i2(p), 0x5455); /* 'UT' extension header */
181 assertEqualInt(i2(p + 2), 5); /* 'UT' size */
182 assertEqualInt(p[4], 1); /* 'UT' flags */
183 assertEqualInt(i4(p + 5), t); /* 'UT' mtime */
184 p += 4 + i2(p + 2);
185
186 /* Note: We don't expect to see zip64 extension in the central
187 * directory, since the writer knows the actual full size by
188 * the time it is ready to write the central directory and has
189 * no reason to insert it then. Info-Zip seems to do the same
190 * thing. */
191
192 /* Just in case: Report any extra extensions. */
193 while (p < extension_end) {
194 failure("Unexpected extension 0x%04X", i2(p));
195 assert(0);
196 p += 4 + i2(p + 2);
197 }
198
199 /* Should have run exactly to end of extra data. */
200 assertEqualAddress(p, extension_end);
201
202 assertEqualAddress(p, eocd);
203
204 /* After Central dir, we find Zip64 eocd and Zip64 eocd locator. */
205 assertEqualMem(p, "PK\006\006", 4); /* Zip64 eocd */
206 assertEqualInt(i8(p + 4), 44); /* We're using v1 Zip64 eocd */
207 assertEqualInt(i2(p + 12), 45); /* Written by Version 4.5 */
208 assertEqualInt(i2(p + 14), 45); /* Needs version 4.5 to extract */
209 assertEqualInt(i4(p + 16), 0); /* This is disk #0 */
210 assertEqualInt(i4(p + 20), 0); /* Dir starts on disk #0 */
211 assertEqualInt(i8(p + 24), 1); /* 1 entry on this disk */
212 assertEqualInt(i8(p + 32), 1); /* 1 entry total */
213 assertEqualInt(i8(p + 40), eocd - central_header); /* size of cd */
214 assertEqualInt(i8(p + 48), central_header - buff); /* start of cd */
215 p += 12 + i8(p + 4);
216
217 assertEqualMem(p, "PK\006\007", 4); /* Zip64 eocd locator */
218 assertEqualInt(i4(p + 4), 0); /* Zip64 eocd is on disk #0 */
219 assertEqualInt(i8(p + 8), eocd - buff); /* Offset of Zip64 eocd */
220 assertEqualInt(i4(p + 16), 1); /* 1 disk */
221 p += 20;
222
223 /* Regular EOCD immediately follows Zip64 records. */
224 assertEqualAddress(p, eocd_record);
225
226 /* Verify local header of file entry. */
227 p = local_header = buff;
228 assertEqualMem(p, "PK\003\004", 4); /* Signature */
229 assertEqualInt(i2(p + 4), zip_version); /* Version needed to extract */
230 assertEqualInt(i2(p + 6), 8); /* Flags: bit 3 = length-at-end */
231 assertEqualInt(i2(p + 8), zip_compression); /* Compression method */
232 assertEqualInt(i2(p + 10), (tm->tm_hour * 2048) + (tm->tm_min * 32) + (tm->tm_sec / 2)); /* File time */
233 assertEqualInt(i2(p + 12), ((tm->tm_year - 80) * 512) + ((tm->tm_mon + 1) * 32) + tm->tm_mday); /* File date */
234 assertEqualInt(i4(p + 14), 0); /* CRC-32 must be 0 because of length-at-end */
235 assertEqualInt(i4(p + 18), 0); /* Compressed size must be 0 because of length-at-end */
236 assertEqualInt(i4(p + 22), 0); /* Uncompressed size must be 0 because of length-at-end. */
237 assertEqualInt(i2(p + 26), strlen(file_name)); /* Pathname length */
238 assertEqualInt(i2(p + 28), 37); /* Extra field length */
239 assertEqualMem(p + 30, file_name, strlen(file_name)); /* Pathname */
240 p = extension_start = local_header + 30 + strlen(file_name);
241 extension_end = extension_start + i2(local_header + 28);
242
243 assertEqualInt(i2(p), 0x7875); /* 'ux' extension header */
244 assertEqualInt(i2(p + 2), 11); /* 'ux' size */
245 assertEqualInt(p[4], 1); /* 'ux' version */
246 assertEqualInt(p[5], 4); /* 'ux' uid size */
247 assertEqualInt(i4(p + 6), file_uid); /* 'Ux' UID */
248 assertEqualInt(p[10], 4); /* 'ux' gid size */
249 assertEqualInt(i4(p + 11), file_gid); /* 'Ux' GID */
250 p += 4 + i2(p + 2);
251
252 assertEqualInt(i2(p), 0x5455); /* 'UT' extension header */
253 assertEqualInt(i2(p + 2), 5); /* 'UT' size */
254 assertEqualInt(p[4], 1); /* 'UT' flags */
255 assertEqualInt(i4(p + 5), t); /* 'UT' mtime */
256 p += 4 + i2(p + 2);
257
258 assertEqualInt(i2(p), 0x6c78); /* 'xl' experimental extension header */
259 assertEqualInt(i2(p + 2), 9); /* size */
260 assertEqualInt(p[4], 7); /* bitmap of included fields */
261 assertEqualInt(i2(p + 5) >> 8, 3); /* system & version made by */
262 assertEqualInt(i2(p + 7), 0); /* internal file attributes */
263 assertEqualInt(i4(p + 9) >> 16 & 01777, file_perm); /* external file attributes */
264 p += 4 + i2(p + 2);
265
266 /* Just in case: Report any extra extensions. */
267 while (p < extension_end) {
268 failure("Unexpected extension 0x%04X", i2(p));
269 assert(0);
270 p += 4 + i2(p + 2);
271 }
272
273 /* Should have run exactly to end of extra data. */
274 assertEqualAddress(p, extension_end);
275
276 /* Data descriptor should follow compressed data. */
277 while (p < central_header && memcmp(p, "PK\007\010", 4) != 0)
278 ++p;
279 assertEqualMem(p, "PK\007\010", 4);
280 assertEqualInt(i4(p + 4), crc); /* CRC-32 */
281 assertEqualInt(i8(p + 8), p - extension_end); /* compressed size */
282 assertEqualInt(i8(p + 16), sizeof(file_data)); /* uncompressed size */
283
284 /* Central directory should immediately follow the only entry. */
285 assertEqualAddress(p + 24, central_header);
286
287 free(buff);
288 }
289