test_format_newc.c revision 348607
1/*-
2 * Copyright (c) 2003-2007 Tim Kientzle
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25#include "test.h"
26__FBSDID("$FreeBSD: stable/11/contrib/libarchive/cpio/test/test_format_newc.c 348607 2019-06-04 10:35:54Z mm $");
27
28/* Number of bytes needed to pad 'n' to multiple of 'block', assuming
29 * that 'block' is a power of two. This trick can be more easily
30 * remembered as -n & (block - 1), but many compilers quite reasonably
31 * warn about "-n" when n is an unsigned value.  (~(n) + 1) is the
32 * same thing, but written in a way that won't offend anyone. */
33#define PAD(n, block)  ((~(n) + 1) & ((block) - 1))
34
35static int
36is_hex(const char *p, size_t l)
37{
38	while (l > 0) {
39		if ((*p >= '0' && *p <= '9')
40		    || (*p >= 'a' && *p <= 'f')
41		    || (*p >= 'A' && *p <= 'F'))
42		{
43			--l;
44			++p;
45		} else
46			return (0);
47
48	}
49	return (1);
50}
51
52static int
53from_hex(const char *p, size_t l)
54{
55	int r = 0;
56
57	while (l > 0) {
58		r *= 16;
59		if (*p >= 'a' && *p <= 'f')
60			r += *p + 10 - 'a';
61		else if (*p >= 'A' && *p <= 'F')
62			r += *p + 10 - 'A';
63		else
64			r += *p - '0';
65		--l;
66		++p;
67	}
68	return (r);
69}
70
71#if !defined(_WIN32) || defined(__CYGWIN__)
72static int
73nlinks(const char *p)
74{
75	struct stat st;
76	assertEqualInt(0, stat(p, &st));
77	return st.st_nlink;
78}
79#endif
80
81DEFINE_TEST(test_format_newc)
82{
83	FILE *list;
84	int r;
85	int devmajor, devminor, ino, gid;
86	int uid = -1;
87	time_t t, t2, now;
88	char *p, *e;
89	size_t s, fs, ns;
90	char result[1024];
91
92	assertUmask(0);
93
94#if !defined(_WIN32)
95	uid = getuid();
96#endif
97
98	/*
99	 * Create an assortment of files.
100	 * TODO: Extend this to cover more filetypes.
101	 */
102	list = fopen("list", "w");
103
104	/* "file1" */
105	assertMakeFile("file1", 0644, "1234567890");
106	fprintf(list, "file1\n");
107
108	/* "hardlink" */
109	assertMakeHardlink("hardlink", "file1");
110	fprintf(list, "hardlink\n");
111
112	/* Another hardlink, but this one won't be archived. */
113	assertMakeHardlink("hardlink2", "file1");
114
115	/* "symlink" */
116	if (canSymlink()) {
117		assertMakeSymlink("symlink", "file1", 0);
118		fprintf(list, "symlink\n");
119	}
120
121	/* "dir" */
122	assertMakeDir("dir", 0775);
123	fprintf(list, "dir\n");
124
125	/* Setup result message. */
126	memset(result, 0, sizeof(result));
127	if (is_LargeInode("file1")) {
128		strncat(result,
129		    "bsdcpio: file1: large inode number truncated: ",
130		    sizeof(result) - strlen(result) -1);
131		strncat(result, strerror(ERANGE),
132		    sizeof(result) - strlen(result) -1);
133		strncat(result, "\n",
134		    sizeof(result) - strlen(result) -1);
135	}
136	if (canSymlink() && is_LargeInode("symlink")) {
137		strncat(result,
138		    "bsdcpio: symlink: large inode number truncated: ",
139		    sizeof(result) - strlen(result) -1);
140		strncat(result, strerror(ERANGE),
141		    sizeof(result) - strlen(result) -1);
142		strncat(result, "\n",
143		    sizeof(result) - strlen(result) -1);
144	}
145	if (is_LargeInode("dir")) {
146		strncat(result,
147		    "bsdcpio: dir: large inode number truncated: ",
148		    sizeof(result) - strlen(result) -1);
149		strncat(result, strerror(ERANGE),
150		    sizeof(result) - strlen(result) -1);
151		strncat(result, "\n",
152		    sizeof(result) - strlen(result) -1);
153	}
154	if (is_LargeInode("hardlink")) {
155		strncat(result,
156		    "bsdcpio: hardlink: large inode number truncated: ",
157		    sizeof(result) - strlen(result) -1);
158		strncat(result, strerror(ERANGE),
159		    sizeof(result) - strlen(result) -1);
160		strncat(result, "\n",
161		    sizeof(result) - strlen(result) -1);
162	}
163
164	/* Record some facts about what we just created: */
165	now = time(NULL); /* They were all created w/in last two seconds. */
166
167	/* Use the cpio program to create an archive. */
168	fclose(list);
169	r = systemf("%s -o --format=newc <list >newc.out 2>newc.err",
170	    testprog);
171	if (!assertEqualInt(r, 0))
172		return;
173
174	/* Verify that nothing went to stderr. */
175	if (canSymlink()) {
176		strncat(result, "2 blocks\n", sizeof(result) - strlen(result) -1);
177	} else {
178		strncat(result, "1 block\n", sizeof(result) - strlen(result) -1);
179	}
180	assertTextFileContents(result, "newc.err");
181
182	/* Verify that stdout is a well-formed cpio file in "newc" format. */
183	p = slurpfile(&s, "newc.out");
184	assertEqualInt(s, canSymlink() ? 1024 : 512);
185	e = p;
186
187	/*
188	 * Some of these assertions could be stronger, but it's
189	 * a little tricky because they depend on the local environment.
190	 */
191
192	/* First entry is "file1" */
193	assert(is_hex(e, 110)); /* Entire header is octal digits. */
194	assertEqualMem(e + 0, "070701", 6); /* Magic */
195	ino = from_hex(e + 6, 8); /* ino */
196#if defined(_WIN32) && !defined(__CYGWIN__)
197	/* Group members bits and others bits do not work. */
198	assertEqualInt(0x8180, from_hex(e + 14, 8) & 0xffc0); /* Mode */
199#else
200	assertEqualInt(0x81a4, from_hex(e + 14, 8)); /* Mode */
201#endif
202	if (uid < 0)
203		uid = from_hex(e + 22, 8);
204	assertEqualInt(from_hex(e + 22, 8), uid); /* uid */
205	gid = from_hex(e + 30, 8); /* gid */
206	assertEqualMem(e + 38, "00000003", 8); /* nlink */
207	t = from_hex(e + 46, 8); /* mtime */
208	failure("t=0x%08x now=0x%08x=%d", t, now, now);
209	assert(t <= now); /* File wasn't created in future. */
210	failure("t=0x%08x now - 2=0x%08x = %d", t, now - 2, now - 2);
211	assert(t >= now - 2); /* File was created w/in last 2 secs. */
212	failure("newc format stores body only with last appearance of a link\n"
213	    "       first appearance should be empty, so this file size\n"
214	    "       field should be zero");
215	assertEqualInt(0, from_hex(e + 54, 8)); /* File size */
216	fs = from_hex(e + 54, 8);
217	fs += PAD(fs, 4);
218	devmajor = from_hex(e + 62, 8); /* devmajor */
219	devminor = from_hex(e + 70, 8); /* devminor */
220	assert(is_hex(e + 78, 8)); /* rdevmajor */
221	assert(is_hex(e + 86, 8)); /* rdevminor */
222	assertEqualMem(e + 94, "00000006", 8); /* Name size */
223	ns = from_hex(e + 94, 8);
224	ns += PAD(ns + 2, 4);
225	assertEqualInt(0, from_hex(e + 102, 8)); /* check field */
226	assertEqualMem(e + 110, "file1\0", 6); /* Name contents */
227	/* Since there's another link, no file contents here. */
228	/* But add in file size so that an error here doesn't cascade. */
229	e += 110 + fs + ns;
230
231	if (canSymlink()) {
232		/* "symlink" pointing to "file1" */
233		assert(is_hex(e, 110));
234		assertEqualMem(e + 0, "070701", 6); /* Magic */
235		assert(is_hex(e + 6, 8)); /* ino */
236#if defined(_WIN32) && !defined(CYGWIN)
237		/* Mode: Group members bits and others bits do not work. */
238		assertEqualInt(0xa180, from_hex(e + 14, 8) & 0xffc0);
239#else
240		assertEqualInt(0xa1ff, from_hex(e + 14, 8)); /* Mode */
241#endif
242		assertEqualInt(from_hex(e + 22, 8), uid); /* uid */
243		assertEqualInt(gid, from_hex(e + 30, 8)); /* gid */
244		assertEqualMem(e + 38, "00000001", 8); /* nlink */
245		t2 = from_hex(e + 46, 8); /* mtime */
246		failure("First entry created at t=0x%08x this entry created at t2=0x%08x", t, t2);
247		assert(t2 == t || t2 == t + 1); /* Almost same as first entry. */
248		assertEqualMem(e + 54, "00000005", 8); /* File size */
249		fs = from_hex(e + 54, 8);
250		fs += PAD(fs, 4);
251		assertEqualInt(devmajor, from_hex(e + 62, 8)); /* devmajor */
252		assertEqualInt(devminor, from_hex(e + 70, 8)); /* devminor */
253		assert(is_hex(e + 78, 8)); /* rdevmajor */
254		assert(is_hex(e + 86, 8)); /* rdevminor */
255		assertEqualMem(e + 94, "00000008", 8); /* Name size */
256		ns = from_hex(e + 94, 8);
257		ns += PAD(ns + 2, 4);
258		assertEqualInt(0, from_hex(e + 102, 8)); /* check field */
259		assertEqualMem(e + 110, "symlink\0\0\0", 10); /* Name contents */
260		assertEqualMem(e + 110 + ns, "file1\0\0\0", 8); /* symlink target */
261		e += 110 + fs + ns;
262	}
263
264	/* "dir" */
265	assert(is_hex(e, 110));
266	assertEqualMem(e + 0, "070701", 6); /* Magic */
267	assert(is_hex(e + 6, 8)); /* ino */
268#if defined(_WIN32) && !defined(__CYGWIN__)
269	/* Group members bits and others bits do not work. */
270	assertEqualInt(0x41c0, from_hex(e + 14, 8) & 0xffc0); /* Mode */
271#else
272	/* Mode: sgid bit sometimes propagates from parent dirs, ignore it. */
273	assertEqualInt(040775, from_hex(e + 14, 8) & ~02000);
274#endif
275	assertEqualInt(uid, from_hex(e + 22, 8)); /* uid */
276	assertEqualInt(gid, from_hex(e + 30, 8)); /* gid */
277#if !defined(_WIN32) || defined(__CYGWIN__)
278	assertEqualInt(nlinks("dir"), from_hex(e + 38, 8)); /* nlinks */
279#endif
280	t2 = from_hex(e + 46, 8); /* mtime */
281	failure("First entry created at t=0x%08x this entry created at t2=0x%08x", t, t2);
282	assert(t2 == t || t2 == t + 1); /* Almost same as first entry. */
283	assertEqualMem(e + 54, "00000000", 8); /* File size */
284	fs = from_hex(e + 54, 8);
285	fs += PAD(fs, 4);
286	assertEqualInt(devmajor, from_hex(e + 62, 8)); /* devmajor */
287	assertEqualInt(devminor, from_hex(e + 70, 8)); /* devminor */
288	assert(is_hex(e + 78, 8)); /* rdevmajor */
289	assert(is_hex(e + 86, 8)); /* rdevminor */
290	assertEqualMem(e + 94, "00000004", 8); /* Name size */
291	ns = from_hex(e + 94, 8);
292	ns += PAD(ns + 2, 4);
293	assertEqualInt(0, from_hex(e + 102, 8)); /* check field */
294	assertEqualMem(e + 110, "dir\0\0\0", 6); /* Name contents */
295	e += 110 + fs + ns;
296
297	/* Hardlink identical to "file1" */
298	/* Since we only wrote two of the three links to this
299	 * file, this link should get deferred by the hardlink logic. */
300	assert(is_hex(e, 110));
301	assertEqualMem(e + 0, "070701", 6); /* Magic */
302	failure("If these aren't the same, then the hardlink detection failed to match them.");
303	assertEqualInt(ino, from_hex(e + 6, 8)); /* ino */
304#if defined(_WIN32) && !defined(__CYGWIN__)
305	/* Group members bits and others bits do not work. */
306	assertEqualInt(0x8180, from_hex(e + 14, 8) & 0xffc0); /* Mode */
307#else
308	assertEqualInt(0x81a4, from_hex(e + 14, 8)); /* Mode */
309#endif
310	assertEqualInt(from_hex(e + 22, 8), uid); /* uid */
311	assertEqualInt(gid, from_hex(e + 30, 8)); /* gid */
312	assertEqualMem(e + 38, "00000003", 8); /* nlink */
313	t2 = from_hex(e + 46, 8); /* mtime */
314	failure("First entry created at t=0x%08x this entry created at t2=0x%08x", t, t2);
315	assert(t2 == t || t2 == t + 1); /* Almost same as first entry. */
316	assertEqualInt(10, from_hex(e + 54, 8)); /* File size */
317	fs = from_hex(e + 54, 8);
318	fs += PAD(fs, 4);
319	assertEqualInt(devmajor, from_hex(e + 62, 8)); /* devmajor */
320	assertEqualInt(devminor, from_hex(e + 70, 8)); /* devminor */
321	assert(is_hex(e + 78, 8)); /* rdevmajor */
322	assert(is_hex(e + 86, 8)); /* rdevminor */
323	assertEqualMem(e + 94, "00000009", 8); /* Name size */
324	ns = from_hex(e + 94, 8);
325	ns += PAD(ns + 2, 4);
326	assertEqualInt(0, from_hex(e + 102, 8)); /* check field */
327	assertEqualMem(e + 110, "hardlink\0\0", 10); /* Name contents */
328	assertEqualMem(e + 110 + ns, "1234567890\0\0", 12); /* File contents */
329	e += 110 + ns + fs;
330
331	/* Last entry is end-of-archive marker. */
332	assert(is_hex(e, 110));
333	assertEqualMem(e + 0, "070701", 6); /* Magic */
334	assertEqualMem(e + 8, "00000000", 8); /* ino */
335	assertEqualMem(e + 14, "00000000", 8); /* mode */
336	assertEqualMem(e + 22, "00000000", 8); /* uid */
337	assertEqualMem(e + 30, "00000000", 8); /* gid */
338	assertEqualMem(e + 38, "00000001", 8); /* nlink */
339	assertEqualMem(e + 46, "00000000", 8); /* mtime */
340	assertEqualMem(e + 54, "00000000", 8); /* size */
341	assertEqualMem(e + 62, "00000000", 8); /* devmajor */
342	assertEqualMem(e + 70, "00000000", 8); /* devminor */
343	assertEqualMem(e + 78, "00000000", 8); /* rdevmajor */
344	assertEqualMem(e + 86, "00000000", 8); /* rdevminor */
345	assertEqualInt(11, from_hex(e + 94, 8)); /* name size */
346	assertEqualMem(e + 102, "00000000", 8); /* check field */
347	assertEqualMem(e + 110, "TRAILER!!!\0\0", 12); /* Name */
348
349	free(p);
350}
351