xref: /freebsd/contrib/libarchive/libarchive/archive_read_disk_entry_from_file.c (revision bd66c1b43e33540205dbc1187c2f2a15c58b57ba)
1 /*-
2  * Copyright (c) 2003-2009 Tim Kientzle
3  * Copyright (c) 2010-2012 Michihiro NAKAJIMA
4  * Copyright (c) 2016 Martin Matuska
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #include "archive_platform.h"
29 
30 /* This is the tree-walking code for POSIX systems. */
31 #if !defined(_WIN32) || defined(__CYGWIN__)
32 
33 #ifdef HAVE_SYS_TYPES_H
34 #include <sys/types.h>
35 #endif
36 #ifdef HAVE_SYS_EXTATTR_H
37 #include <sys/extattr.h>
38 #endif
39 #ifdef HAVE_SYS_IOCTL_H
40 #include <sys/ioctl.h>
41 #endif
42 #ifdef HAVE_SYS_PARAM_H
43 #include <sys/param.h>
44 #endif
45 #ifdef HAVE_SYS_STAT_H
46 #include <sys/stat.h>
47 #endif
48 #if defined(HAVE_SYS_XATTR_H)
49 #include <sys/xattr.h>
50 #elif defined(HAVE_ATTR_XATTR_H)
51 #include <attr/xattr.h>
52 #endif
53 #ifdef HAVE_SYS_EA_H
54 #include <sys/ea.h>
55 #endif
56 #ifdef HAVE_COPYFILE_H
57 #include <copyfile.h>
58 #endif
59 #ifdef HAVE_ERRNO_H
60 #include <errno.h>
61 #endif
62 #ifdef HAVE_FCNTL_H
63 #include <fcntl.h>
64 #endif
65 #ifdef HAVE_LIMITS_H
66 #include <limits.h>
67 #endif
68 #ifdef HAVE_LINUX_TYPES_H
69 #include <linux/types.h>
70 #endif
71 #ifdef HAVE_LINUX_FIEMAP_H
72 #include <linux/fiemap.h>
73 #endif
74 #ifdef HAVE_LINUX_FS_H
75 #include <linux/fs.h>
76 #endif
77 /*
78  * Some Linux distributions have both linux/ext2_fs.h and ext2fs/ext2_fs.h.
79  * As the include guards don't agree, the order of include is important.
80  */
81 #ifdef HAVE_LINUX_EXT2_FS_H
82 #include <linux/ext2_fs.h>      /* for Linux file flags */
83 #endif
84 #if defined(HAVE_EXT2FS_EXT2_FS_H) && !defined(__CYGWIN__)
85 #include <ext2fs/ext2_fs.h>     /* Linux file flags, broken on Cygwin */
86 #endif
87 #ifdef HAVE_PATHS_H
88 #include <paths.h>
89 #endif
90 #ifdef HAVE_UNISTD_H
91 #include <unistd.h>
92 #endif
93 
94 #include "archive.h"
95 #include "archive_entry.h"
96 #include "archive_private.h"
97 #include "archive_read_disk_private.h"
98 
99 #ifndef O_CLOEXEC
100 #define O_CLOEXEC	0
101 #endif
102 
103 static int setup_mac_metadata(struct archive_read_disk *,
104     struct archive_entry *, int *fd);
105 #ifdef ARCHIVE_XATTR_FREEBSD
106 static int setup_xattrs_namespace(struct archive_read_disk *,
107     struct archive_entry *, int *, int);
108 #endif
109 static int setup_xattrs(struct archive_read_disk *,
110     struct archive_entry *, int *fd);
111 static int setup_sparse(struct archive_read_disk *,
112     struct archive_entry *, int *fd);
113 #if defined(HAVE_LINUX_FIEMAP_H)
114 static int setup_sparse_fiemap(struct archive_read_disk *,
115     struct archive_entry *, int *fd);
116 #endif
117 
118 #if !ARCHIVE_ACL_SUPPORT
119 int
archive_read_disk_entry_setup_acls(struct archive_read_disk * a,struct archive_entry * entry,int * fd)120 archive_read_disk_entry_setup_acls(struct archive_read_disk *a,
121     struct archive_entry *entry, int *fd)
122 {
123 	(void)a;      /* UNUSED */
124 	(void)entry;  /* UNUSED */
125 	(void)fd;     /* UNUSED */
126 	return (ARCHIVE_OK);
127 }
128 #endif
129 
130 /*
131  * Enter working directory and return working pathname of archive_entry.
132  * If a pointer to an integer is provided and its value is below zero
133  * open a file descriptor on this pathname.
134  */
135 const char *
archive_read_disk_entry_setup_path(struct archive_read_disk * a,struct archive_entry * entry,int * fd)136 archive_read_disk_entry_setup_path(struct archive_read_disk *a,
137     struct archive_entry *entry, int *fd)
138 {
139 	const char *path;
140 
141 	path = archive_entry_sourcepath(entry);
142 
143 	if (path == NULL || (a->tree != NULL &&
144 	    a->tree_enter_working_dir(a->tree) != 0))
145 		path = archive_entry_pathname(entry);
146 	if (path == NULL) {
147 		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
148 		   "Couldn't determine path");
149 	} else if (fd != NULL && *fd < 0 && a->tree != NULL &&
150 	    (a->follow_symlinks || archive_entry_filetype(entry) != AE_IFLNK)) {
151 		*fd = a->open_on_current_dir(a->tree, path,
152 		    O_RDONLY | O_NONBLOCK);
153 	}
154 	return (path);
155 }
156 
157 int
archive_read_disk_entry_from_file(struct archive * _a,struct archive_entry * entry,int fd,const struct stat * st)158 archive_read_disk_entry_from_file(struct archive *_a,
159     struct archive_entry *entry,
160     int fd,
161     const struct stat *st)
162 {
163 	struct archive_read_disk *a = (struct archive_read_disk *)_a;
164 	const char *path, *name;
165 	struct stat s;
166 	int initial_fd = fd;
167 	int r, r1;
168 
169 	archive_check_magic(_a, ARCHIVE_READ_DISK_MAGIC, ARCHIVE_STATE_ANY,
170 		"archive_read_disk_entry_from_file");
171 
172 	archive_clear_error(_a);
173 	path = archive_entry_sourcepath(entry);
174 	if (path == NULL)
175 		path = archive_entry_pathname(entry);
176 
177 	if (a->tree == NULL) {
178 		if (st == NULL) {
179 #if HAVE_FSTAT
180 			if (fd >= 0) {
181 				if (fstat(fd, &s) != 0) {
182 					archive_set_error(&a->archive, errno,
183 					    "Can't fstat");
184 					return (ARCHIVE_FAILED);
185 				}
186 			} else
187 #endif
188 #if HAVE_LSTAT
189 			if (!a->follow_symlinks) {
190 				if (lstat(path, &s) != 0) {
191 					archive_set_error(&a->archive, errno,
192 					    "Can't lstat %s", path);
193 					return (ARCHIVE_FAILED);
194 				}
195 			} else
196 #endif
197 			if (la_stat(path, &s) != 0) {
198 				archive_set_error(&a->archive, errno,
199 				    "Can't stat %s", path);
200 				return (ARCHIVE_FAILED);
201 			}
202 			st = &s;
203 		}
204 		archive_entry_copy_stat(entry, st);
205 	}
206 
207 	/* Lookup uname/gname */
208 	name = archive_read_disk_uname(_a, archive_entry_uid(entry));
209 	if (name != NULL)
210 		archive_entry_copy_uname(entry, name);
211 	name = archive_read_disk_gname(_a, archive_entry_gid(entry));
212 	if (name != NULL)
213 		archive_entry_copy_gname(entry, name);
214 
215 #ifdef HAVE_STRUCT_STAT_ST_FLAGS
216 	/* On FreeBSD, we get flags for free with the stat. */
217 	/* TODO: Does this belong in copy_stat()? */
218 	if ((a->flags & ARCHIVE_READDISK_NO_FFLAGS) == 0 && st->st_flags != 0)
219 		archive_entry_set_fflags(entry, st->st_flags, 0);
220 #endif
221 
222 #if (defined(FS_IOC_GETFLAGS) && defined(HAVE_WORKING_FS_IOC_GETFLAGS)) || \
223     (defined(EXT2_IOC_GETFLAGS) && defined(HAVE_WORKING_EXT2_IOC_GETFLAGS))
224 	/* Linux requires an extra ioctl to pull the flags.  Although
225 	 * this is an extra step, it has a nice side-effect: We get an
226 	 * open file descriptor which we can use in the subsequent lookups. */
227 	if ((a->flags & ARCHIVE_READDISK_NO_FFLAGS) == 0 &&
228 	    (S_ISREG(st->st_mode) || S_ISDIR(st->st_mode))) {
229 		if (fd < 0) {
230 			if (a->tree != NULL)
231 				fd = a->open_on_current_dir(a->tree, path,
232 					O_RDONLY | O_NONBLOCK | O_CLOEXEC);
233 			else
234 				fd = open(path, O_RDONLY | O_NONBLOCK |
235 						O_CLOEXEC);
236 			__archive_ensure_cloexec_flag(fd);
237 		}
238 		if (fd >= 0) {
239 			int stflags;
240 			r = ioctl(fd,
241 #if defined(FS_IOC_GETFLAGS)
242 			    FS_IOC_GETFLAGS,
243 #else
244 			    EXT2_IOC_GETFLAGS,
245 #endif
246 			    &stflags);
247 			if (r == 0 && stflags != 0)
248 				archive_entry_set_fflags(entry, stflags, 0);
249 		}
250 	}
251 #endif
252 
253 #if defined(HAVE_READLINK) || defined(HAVE_READLINKAT)
254 	if (S_ISLNK(st->st_mode)) {
255 		size_t linkbuffer_len = st->st_size;
256 		char *linkbuffer;
257 		int lnklen;
258 
259 		linkbuffer = malloc(linkbuffer_len + 1);
260 		if (linkbuffer == NULL) {
261 			archive_set_error(&a->archive, ENOMEM,
262 			    "Couldn't read link data");
263 			return (ARCHIVE_FAILED);
264 		}
265 		if (a->tree != NULL) {
266 #ifdef HAVE_READLINKAT
267 			lnklen = readlinkat(a->tree_current_dir_fd(a->tree),
268 			    path, linkbuffer, linkbuffer_len);
269 #else
270 			if (a->tree_enter_working_dir(a->tree) != 0) {
271 				archive_set_error(&a->archive, errno,
272 				    "Couldn't read link data");
273 				free(linkbuffer);
274 				return (ARCHIVE_FAILED);
275 			}
276 			lnklen = readlink(path, linkbuffer, linkbuffer_len);
277 #endif /* HAVE_READLINKAT */
278 		} else
279 			lnklen = readlink(path, linkbuffer, linkbuffer_len);
280 		if (lnklen < 0) {
281 			archive_set_error(&a->archive, errno,
282 			    "Couldn't read link data");
283 			free(linkbuffer);
284 			return (ARCHIVE_FAILED);
285 		}
286 		linkbuffer[lnklen] = '\0';
287 		archive_entry_set_symlink(entry, linkbuffer);
288 		free(linkbuffer);
289 	}
290 #endif /* HAVE_READLINK || HAVE_READLINKAT */
291 
292 	r = 0;
293 	if ((a->flags & ARCHIVE_READDISK_NO_ACL) == 0)
294 		r = archive_read_disk_entry_setup_acls(a, entry, &fd);
295 	if ((a->flags & ARCHIVE_READDISK_NO_XATTR) == 0) {
296 		r1 = setup_xattrs(a, entry, &fd);
297 		if (r1 < r)
298 			r = r1;
299 	}
300 	if (a->flags & ARCHIVE_READDISK_MAC_COPYFILE) {
301 		r1 = setup_mac_metadata(a, entry, &fd);
302 		if (r1 < r)
303 			r = r1;
304 	}
305 	if ((a->flags & ARCHIVE_READDISK_NO_SPARSE) == 0) {
306 		r1 = setup_sparse(a, entry, &fd);
307 		if (r1 < r)
308 			r = r1;
309 	}
310 
311 	/* If we opened the file earlier in this function, close it. */
312 	if (initial_fd != fd)
313 		close(fd);
314 	return (r);
315 }
316 
317 #if defined(__APPLE__) && defined(HAVE_COPYFILE_H)
318 /*
319  * The Mac OS "copyfile()" API copies the extended metadata for a
320  * file into a separate file in AppleDouble format (see RFC 1740).
321  *
322  * Mac OS tar and cpio implementations store this extended
323  * metadata as a separate entry just before the regular entry
324  * with a "._" prefix added to the filename.
325  *
326  * Note that this is currently done unconditionally; the tar program has
327  * an option to discard this information before the archive is written.
328  *
329  * TODO: If there's a failure, report it and return ARCHIVE_WARN.
330  */
331 static int
setup_mac_metadata(struct archive_read_disk * a,struct archive_entry * entry,int * fd)332 setup_mac_metadata(struct archive_read_disk *a,
333     struct archive_entry *entry, int *fd)
334 {
335 	int tempfd = -1;
336 	int copyfile_flags = COPYFILE_NOFOLLOW | COPYFILE_ACL | COPYFILE_XATTR;
337 	struct stat copyfile_stat;
338 	int ret = ARCHIVE_OK;
339 	void *buff = NULL;
340 	int have_attrs;
341 	const char *name, *tempdir;
342 	struct archive_string tempfile;
343 
344 	(void)fd; /* UNUSED */
345 
346 	name = archive_read_disk_entry_setup_path(a, entry, NULL);
347 	if (name == NULL)
348 		return (ARCHIVE_WARN);
349 
350 	/* Short-circuit if there's nothing to do. */
351 	have_attrs = copyfile(name, NULL, 0, copyfile_flags | COPYFILE_CHECK);
352 	if (have_attrs == -1) {
353 		archive_set_error(&a->archive, errno,
354 			"Could not check extended attributes");
355 		return (ARCHIVE_WARN);
356 	}
357 	if (have_attrs == 0)
358 		return (ARCHIVE_OK);
359 
360 	tempdir = NULL;
361 	if (issetugid() == 0)
362 		tempdir = getenv("TMPDIR");
363 	if (tempdir == NULL)
364 		tempdir = _PATH_TMP;
365 	archive_string_init(&tempfile);
366 	archive_strcpy(&tempfile, tempdir);
367 	archive_strcat(&tempfile, "tar.md.XXXXXX");
368 	tempfd = mkstemp(tempfile.s);
369 	if (tempfd < 0) {
370 		archive_set_error(&a->archive, errno,
371 		    "Could not open extended attribute file");
372 		ret = ARCHIVE_WARN;
373 		goto cleanup;
374 	}
375 	__archive_ensure_cloexec_flag(tempfd);
376 
377 	/* XXX I wish copyfile() could pack directly to a memory
378 	 * buffer; that would avoid the temp file here.  For that
379 	 * matter, it would be nice if fcopyfile() actually worked,
380 	 * that would reduce the many open/close races here. */
381 	if (copyfile(name, tempfile.s, 0, copyfile_flags | COPYFILE_PACK)) {
382 		archive_set_error(&a->archive, errno,
383 		    "Could not pack extended attributes");
384 		ret = ARCHIVE_WARN;
385 		goto cleanup;
386 	}
387 	if (fstat(tempfd, &copyfile_stat)) {
388 		archive_set_error(&a->archive, errno,
389 		    "Could not check size of extended attributes");
390 		ret = ARCHIVE_WARN;
391 		goto cleanup;
392 	}
393 	buff = malloc(copyfile_stat.st_size);
394 	if (buff == NULL) {
395 		archive_set_error(&a->archive, errno,
396 		    "Could not allocate memory for extended attributes");
397 		ret = ARCHIVE_WARN;
398 		goto cleanup;
399 	}
400 	if (copyfile_stat.st_size != read(tempfd, buff, copyfile_stat.st_size)) {
401 		archive_set_error(&a->archive, errno,
402 		    "Could not read extended attributes into memory");
403 		ret = ARCHIVE_WARN;
404 		goto cleanup;
405 	}
406 	archive_entry_copy_mac_metadata(entry, buff, copyfile_stat.st_size);
407 
408 cleanup:
409 	if (tempfd >= 0) {
410 		close(tempfd);
411 		unlink(tempfile.s);
412 	}
413 	archive_string_free(&tempfile);
414 	free(buff);
415 	return (ret);
416 }
417 
418 #else
419 
420 /*
421  * Stub implementation for non-Mac systems.
422  */
423 static int
setup_mac_metadata(struct archive_read_disk * a,struct archive_entry * entry,int * fd)424 setup_mac_metadata(struct archive_read_disk *a,
425     struct archive_entry *entry, int *fd)
426 {
427 	(void)a; /* UNUSED */
428 	(void)entry; /* UNUSED */
429 	(void)fd; /* UNUSED */
430 	return (ARCHIVE_OK);
431 }
432 #endif
433 
434 #if ARCHIVE_XATTR_LINUX || ARCHIVE_XATTR_DARWIN || ARCHIVE_XATTR_AIX
435 
436 /*
437  * Linux, Darwin and AIX extended attribute support.
438  *
439  * TODO:  By using a stack-allocated buffer for the first
440  * call to getxattr(), we might be able to avoid the second
441  * call entirely.  We only need the second call if the
442  * stack-allocated buffer is too small.  But a modest buffer
443  * of 1024 bytes or so will often be big enough.  Same applies
444  * to listxattr().
445  */
446 
447 
448 static int
setup_xattr(struct archive_read_disk * a,struct archive_entry * entry,const char * name,int fd,const char * accpath)449 setup_xattr(struct archive_read_disk *a,
450     struct archive_entry *entry, const char *name, int fd, const char *accpath)
451 {
452 	ssize_t size;
453 	void *value = NULL;
454 
455 
456 	if (fd >= 0) {
457 #if ARCHIVE_XATTR_LINUX
458 		size = fgetxattr(fd, name, NULL, 0);
459 #elif ARCHIVE_XATTR_DARWIN
460 		size = fgetxattr(fd, name, NULL, 0, 0, 0);
461 #elif ARCHIVE_XATTR_AIX
462 		size = fgetea(fd, name, NULL, 0);
463 #endif
464 	} else if (!a->follow_symlinks) {
465 #if ARCHIVE_XATTR_LINUX
466 		size = lgetxattr(accpath, name, NULL, 0);
467 #elif ARCHIVE_XATTR_DARWIN
468 		size = getxattr(accpath, name, NULL, 0, 0, XATTR_NOFOLLOW);
469 #elif ARCHIVE_XATTR_AIX
470 		size = lgetea(accpath, name, NULL, 0);
471 #endif
472 	} else {
473 #if ARCHIVE_XATTR_LINUX
474 		size = getxattr(accpath, name, NULL, 0);
475 #elif ARCHIVE_XATTR_DARWIN
476 		size = getxattr(accpath, name, NULL, 0, 0, 0);
477 #elif ARCHIVE_XATTR_AIX
478 		size = getea(accpath, name, NULL, 0);
479 #endif
480 	}
481 
482 	if (size == -1) {
483 		archive_set_error(&a->archive, errno,
484 		    "Couldn't query extended attribute");
485 		return (ARCHIVE_WARN);
486 	}
487 
488 	if (size > 0 && (value = malloc(size)) == NULL) {
489 		archive_set_error(&a->archive, errno, "Out of memory");
490 		return (ARCHIVE_FATAL);
491 	}
492 
493 
494 	if (fd >= 0) {
495 #if ARCHIVE_XATTR_LINUX
496 		size = fgetxattr(fd, name, value, size);
497 #elif ARCHIVE_XATTR_DARWIN
498 		size = fgetxattr(fd, name, value, size, 0, 0);
499 #elif ARCHIVE_XATTR_AIX
500 		size = fgetea(fd, name, value, size);
501 #endif
502 	} else if (!a->follow_symlinks) {
503 #if ARCHIVE_XATTR_LINUX
504 		size = lgetxattr(accpath, name, value, size);
505 #elif ARCHIVE_XATTR_DARWIN
506 		size = getxattr(accpath, name, value, size, 0, XATTR_NOFOLLOW);
507 #elif ARCHIVE_XATTR_AIX
508 		size = lgetea(accpath, name, value, size);
509 #endif
510 	} else {
511 #if ARCHIVE_XATTR_LINUX
512 		size = getxattr(accpath, name, value, size);
513 #elif ARCHIVE_XATTR_DARWIN
514 		size = getxattr(accpath, name, value, size, 0, 0);
515 #elif ARCHIVE_XATTR_AIX
516 		size = getea(accpath, name, value, size);
517 #endif
518 	}
519 
520 	if (size == -1) {
521 		archive_set_error(&a->archive, errno,
522 		    "Couldn't read extended attribute");
523 		free(value);
524 		return (ARCHIVE_WARN);
525 	}
526 
527 	archive_entry_xattr_add_entry(entry, name, value, size);
528 
529 	free(value);
530 	return (ARCHIVE_OK);
531 }
532 
533 static int
setup_xattrs(struct archive_read_disk * a,struct archive_entry * entry,int * fd)534 setup_xattrs(struct archive_read_disk *a,
535     struct archive_entry *entry, int *fd)
536 {
537 	char *list, *p;
538 	const char *path;
539 	ssize_t list_size;
540 
541 	path = NULL;
542 
543 	if (*fd < 0) {
544 		path = archive_read_disk_entry_setup_path(a, entry, fd);
545 		if (path == NULL)
546 			return (ARCHIVE_WARN);
547 	}
548 
549 	if (*fd >= 0) {
550 #if ARCHIVE_XATTR_LINUX
551 		list_size = flistxattr(*fd, NULL, 0);
552 #elif ARCHIVE_XATTR_DARWIN
553 		list_size = flistxattr(*fd, NULL, 0, 0);
554 #elif ARCHIVE_XATTR_AIX
555 		list_size = flistea(*fd, NULL, 0);
556 #endif
557 	} else if (!a->follow_symlinks) {
558 #if ARCHIVE_XATTR_LINUX
559 		list_size = llistxattr(path, NULL, 0);
560 #elif ARCHIVE_XATTR_DARWIN
561 		list_size = listxattr(path, NULL, 0, XATTR_NOFOLLOW);
562 #elif ARCHIVE_XATTR_AIX
563 		list_size = llistea(path, NULL, 0);
564 #endif
565 	} else {
566 #if ARCHIVE_XATTR_LINUX
567 		list_size = listxattr(path, NULL, 0);
568 #elif ARCHIVE_XATTR_DARWIN
569 		list_size = listxattr(path, NULL, 0, 0);
570 #elif ARCHIVE_XATTR_AIX
571 		list_size = listea(path, NULL, 0);
572 #endif
573 	}
574 
575 	if (list_size == -1) {
576 		if (errno == ENOTSUP || errno == ENOSYS)
577 			return (ARCHIVE_OK);
578 		archive_set_error(&a->archive, errno,
579 			"Couldn't list extended attributes");
580 		return (ARCHIVE_WARN);
581 	}
582 
583 	if (list_size == 0)
584 		return (ARCHIVE_OK);
585 
586 	if ((list = malloc(list_size)) == NULL) {
587 		archive_set_error(&a->archive, errno, "Out of memory");
588 		return (ARCHIVE_FATAL);
589 	}
590 
591 	if (*fd >= 0) {
592 #if ARCHIVE_XATTR_LINUX
593 		list_size = flistxattr(*fd, list, list_size);
594 #elif ARCHIVE_XATTR_DARWIN
595 		list_size = flistxattr(*fd, list, list_size, 0);
596 #elif ARCHIVE_XATTR_AIX
597 		list_size = flistea(*fd, list, list_size);
598 #endif
599 	} else if (!a->follow_symlinks) {
600 #if ARCHIVE_XATTR_LINUX
601 		list_size = llistxattr(path, list, list_size);
602 #elif ARCHIVE_XATTR_DARWIN
603 		list_size = listxattr(path, list, list_size, XATTR_NOFOLLOW);
604 #elif ARCHIVE_XATTR_AIX
605 		list_size = llistea(path, list, list_size);
606 #endif
607 	} else {
608 #if ARCHIVE_XATTR_LINUX
609 		list_size = listxattr(path, list, list_size);
610 #elif ARCHIVE_XATTR_DARWIN
611 		list_size = listxattr(path, list, list_size, 0);
612 #elif ARCHIVE_XATTR_AIX
613 		list_size = listea(path, list, list_size);
614 #endif
615 	}
616 
617 	if (list_size == -1) {
618 		archive_set_error(&a->archive, errno,
619 			"Couldn't retrieve extended attributes");
620 		free(list);
621 		return (ARCHIVE_WARN);
622 	}
623 
624 	for (p = list; (p - list) < list_size; p += strlen(p) + 1) {
625 #if ARCHIVE_XATTR_LINUX
626 		/* Linux: skip POSIX.1e ACL extended attributes */
627 		if (strncmp(p, "system.", 7) == 0 &&
628 		   (strcmp(p + 7, "posix_acl_access") == 0 ||
629 		    strcmp(p + 7, "posix_acl_default") == 0))
630 			continue;
631 		if (strncmp(p, "trusted.SGI_", 12) == 0 &&
632 		   (strcmp(p + 12, "ACL_DEFAULT") == 0 ||
633 		    strcmp(p + 12, "ACL_FILE") == 0))
634 			continue;
635 
636 		/* Linux: xfsroot namespace is obsolete and unsupported */
637 		if (strncmp(p, "xfsroot.", 8) == 0)
638 			continue;
639 #endif
640 		setup_xattr(a, entry, p, *fd, path);
641 	}
642 
643 	free(list);
644 	return (ARCHIVE_OK);
645 }
646 
647 #elif ARCHIVE_XATTR_FREEBSD
648 
649 /*
650  * FreeBSD extattr interface.
651  */
652 
653 /* TODO: Implement this.  Follow the Linux model above, but
654  * with FreeBSD-specific system calls, of course.  Be careful
655  * to not include the system extattrs that hold ACLs; we handle
656  * those separately.
657  */
658 static int
659 setup_xattr(struct archive_read_disk *a, struct archive_entry *entry,
660     int namespace, const char *name, const char *fullname, int fd,
661     const char *path);
662 
663 static int
setup_xattr(struct archive_read_disk * a,struct archive_entry * entry,int namespace,const char * name,const char * fullname,int fd,const char * accpath)664 setup_xattr(struct archive_read_disk *a, struct archive_entry *entry,
665     int namespace, const char *name, const char *fullname, int fd,
666     const char *accpath)
667 {
668 	ssize_t size;
669 	void *value = NULL;
670 
671 	if (fd >= 0)
672 		size = extattr_get_fd(fd, namespace, name, NULL, 0);
673 	else if (!a->follow_symlinks)
674 		size = extattr_get_link(accpath, namespace, name, NULL, 0);
675 	else
676 		size = extattr_get_file(accpath, namespace, name, NULL, 0);
677 
678 	if (size == -1) {
679 		archive_set_error(&a->archive, errno,
680 		    "Couldn't query extended attribute");
681 		return (ARCHIVE_WARN);
682 	}
683 
684 	if (size > 0 && (value = malloc(size)) == NULL) {
685 		archive_set_error(&a->archive, errno, "Out of memory");
686 		return (ARCHIVE_FATAL);
687 	}
688 
689 	if (fd >= 0)
690 		size = extattr_get_fd(fd, namespace, name, value, size);
691 	else if (!a->follow_symlinks)
692 		size = extattr_get_link(accpath, namespace, name, value, size);
693 	else
694 		size = extattr_get_file(accpath, namespace, name, value, size);
695 
696 	if (size == -1) {
697 		free(value);
698 		archive_set_error(&a->archive, errno,
699 		    "Couldn't read extended attribute");
700 		return (ARCHIVE_WARN);
701 	}
702 
703 	archive_entry_xattr_add_entry(entry, fullname, value, size);
704 
705 	free(value);
706 	return (ARCHIVE_OK);
707 }
708 
709 static int
setup_xattrs_namespace(struct archive_read_disk * a,struct archive_entry * entry,int * fd,int namespace)710 setup_xattrs_namespace(struct archive_read_disk *a,
711     struct archive_entry *entry, int *fd, int namespace)
712 {
713 	char buff[512];
714 	char *list, *p;
715 	ssize_t list_size;
716 	const char *path;
717 
718 	path = NULL;
719 
720 	if (*fd < 0) {
721 		path = archive_read_disk_entry_setup_path(a, entry, fd);
722 		if (path == NULL)
723 			return (ARCHIVE_WARN);
724 	}
725 
726 	if (*fd >= 0)
727 		list_size = extattr_list_fd(*fd, namespace, NULL, 0);
728 	else if (!a->follow_symlinks)
729 		list_size = extattr_list_link(path, namespace, NULL, 0);
730 	else
731 		list_size = extattr_list_file(path, namespace, NULL, 0);
732 
733 	if (list_size == -1 && errno == EOPNOTSUPP)
734 		return (ARCHIVE_OK);
735 	if (list_size == -1 && errno == EPERM)
736 		return (ARCHIVE_OK);
737 	if (list_size == -1) {
738 		archive_set_error(&a->archive, errno,
739 			"Couldn't list extended attributes");
740 		return (ARCHIVE_WARN);
741 	}
742 
743 	if (list_size == 0)
744 		return (ARCHIVE_OK);
745 
746 	if ((list = malloc(list_size)) == NULL) {
747 		archive_set_error(&a->archive, errno, "Out of memory");
748 		return (ARCHIVE_FATAL);
749 	}
750 
751 	if (*fd >= 0)
752 		list_size = extattr_list_fd(*fd, namespace, list, list_size);
753 	else if (!a->follow_symlinks)
754 		list_size = extattr_list_link(path, namespace, list, list_size);
755 	else
756 		list_size = extattr_list_file(path, namespace, list, list_size);
757 
758 	if (list_size == -1) {
759 		archive_set_error(&a->archive, errno,
760 			"Couldn't retrieve extended attributes");
761 		free(list);
762 		return (ARCHIVE_WARN);
763 	}
764 
765 	p = list;
766 	while ((p - list) < list_size) {
767 		size_t len = 255 & (int)*p;
768 		char *name;
769 
770 		if (namespace == EXTATTR_NAMESPACE_SYSTEM) {
771 			if (!strcmp(p + 1, "nfs4.acl") ||
772 			    !strcmp(p + 1, "posix1e.acl_access") ||
773 			    !strcmp(p + 1, "posix1e.acl_default")) {
774 				p += 1 + len;
775 				continue;
776 			}
777 			strcpy(buff, "system.");
778 		} else {
779 			strcpy(buff, "user.");
780 		}
781 		name = buff + strlen(buff);
782 		memcpy(name, p + 1, len);
783 		name[len] = '\0';
784 		setup_xattr(a, entry, namespace, name, buff, *fd, path);
785 		p += 1 + len;
786 	}
787 
788 	free(list);
789 	return (ARCHIVE_OK);
790 }
791 
792 static int
setup_xattrs(struct archive_read_disk * a,struct archive_entry * entry,int * fd)793 setup_xattrs(struct archive_read_disk *a,
794     struct archive_entry *entry, int *fd)
795 {
796 	int namespaces[2];
797 	int i, res;
798 
799 	namespaces[0] = EXTATTR_NAMESPACE_USER;
800 	namespaces[1] = EXTATTR_NAMESPACE_SYSTEM;
801 
802 	for (i = 0; i < 2; i++) {
803 		res = setup_xattrs_namespace(a, entry, fd,
804 		    namespaces[i]);
805 		switch (res) {
806 			case (ARCHIVE_OK):
807 			case (ARCHIVE_WARN):
808 				break;
809 			default:
810 				return (res);
811 		}
812 	}
813 
814 	return (ARCHIVE_OK);
815 }
816 
817 #else
818 
819 /*
820  * Generic (stub) extended attribute support.
821  */
822 static int
setup_xattrs(struct archive_read_disk * a,struct archive_entry * entry,int * fd)823 setup_xattrs(struct archive_read_disk *a,
824     struct archive_entry *entry, int *fd)
825 {
826 	(void)a;     /* UNUSED */
827 	(void)entry; /* UNUSED */
828 	(void)fd;    /* UNUSED */
829 	return (ARCHIVE_OK);
830 }
831 
832 #endif
833 
834 #if defined(HAVE_LINUX_FIEMAP_H)
835 
836 /*
837  * Linux FIEMAP sparse interface.
838  *
839  * The FIEMAP ioctl returns an "extent" for each physical allocation
840  * on disk.  We need to process those to generate a more compact list
841  * of logical file blocks.  We also need to be very careful to use
842  * FIEMAP_FLAG_SYNC here, since there are reports that Linux sometimes
843  * does not report allocations for newly-written data that hasn't
844  * been synced to disk.
845  *
846  * It's important to return a minimal sparse file list because we want
847  * to not trigger sparse file extensions if we don't have to, since
848  * not all readers support them.
849  */
850 
851 static int
setup_sparse_fiemap(struct archive_read_disk * a,struct archive_entry * entry,int * fd)852 setup_sparse_fiemap(struct archive_read_disk *a,
853     struct archive_entry *entry, int *fd)
854 {
855 	char buff[4096];
856 	struct fiemap *fm;
857 	struct fiemap_extent *fe;
858 	int64_t size;
859 	int count, do_fiemap, iters;
860 	int exit_sts = ARCHIVE_OK;
861 	const char *path;
862 
863 	if (archive_entry_filetype(entry) != AE_IFREG
864 	    || archive_entry_size(entry) <= 0
865 	    || archive_entry_hardlink(entry) != NULL)
866 		return (ARCHIVE_OK);
867 
868 	if (*fd < 0) {
869 		path = archive_read_disk_entry_setup_path(a, entry, NULL);
870 		if (path == NULL)
871 			return (ARCHIVE_FAILED);
872 
873 		if (a->tree != NULL)
874 			*fd = a->open_on_current_dir(a->tree, path,
875 				O_RDONLY | O_NONBLOCK | O_CLOEXEC);
876 		else
877 			*fd = open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
878 		if (*fd < 0) {
879 			archive_set_error(&a->archive, errno,
880 			    "Can't open `%s'", path);
881 			return (ARCHIVE_FAILED);
882 		}
883 		__archive_ensure_cloexec_flag(*fd);
884 	}
885 
886 	/* Initialize buffer to avoid the error valgrind complains about. */
887 	memset(buff, 0, sizeof(buff));
888 	count = (sizeof(buff) - sizeof(*fm))/sizeof(*fe);
889 	fm = (struct fiemap *)buff;
890 	fm->fm_start = 0;
891 	fm->fm_length = ~0ULL;;
892 	fm->fm_flags = FIEMAP_FLAG_SYNC;
893 	fm->fm_extent_count = count;
894 	do_fiemap = 1;
895 	size = archive_entry_size(entry);
896 	for (iters = 0; ; ++iters) {
897 		int i, r;
898 
899 		r = ioctl(*fd, FS_IOC_FIEMAP, fm);
900 		if (r < 0) {
901 			/* When something error happens, it is better we
902 			 * should return ARCHIVE_OK because an earlier
903 			 * version(<2.6.28) cannot perform FS_IOC_FIEMAP. */
904 			goto exit_setup_sparse_fiemap;
905 		}
906 		if (fm->fm_mapped_extents == 0) {
907 			if (iters == 0) {
908 				/* Fully sparse file; insert a zero-length "data" entry */
909 				archive_entry_sparse_add_entry(entry, 0, 0);
910 			}
911 			break;
912 		}
913 		fe = fm->fm_extents;
914 		for (i = 0; i < (int)fm->fm_mapped_extents; i++, fe++) {
915 			if (!(fe->fe_flags & FIEMAP_EXTENT_UNWRITTEN)) {
916 				/* The fe_length of the last block does not
917 				 * adjust itself to its size files. */
918 				int64_t length = fe->fe_length;
919 				if (fe->fe_logical + length > (uint64_t)size)
920 					length -= fe->fe_logical + length - size;
921 				if (fe->fe_logical == 0 && length == size) {
922 					/* This is not sparse. */
923 					do_fiemap = 0;
924 					break;
925 				}
926 				if (length > 0)
927 					archive_entry_sparse_add_entry(entry,
928 					    fe->fe_logical, length);
929 			}
930 			if (fe->fe_flags & FIEMAP_EXTENT_LAST)
931 				do_fiemap = 0;
932 		}
933 		if (do_fiemap) {
934 			fe = fm->fm_extents + fm->fm_mapped_extents -1;
935 			fm->fm_start = fe->fe_logical + fe->fe_length;
936 		} else
937 			break;
938 	}
939 exit_setup_sparse_fiemap:
940 	return (exit_sts);
941 }
942 
943 #if !defined(SEEK_HOLE) || !defined(SEEK_DATA)
944 static int
setup_sparse(struct archive_read_disk * a,struct archive_entry * entry,int * fd)945 setup_sparse(struct archive_read_disk *a,
946     struct archive_entry *entry, int *fd)
947 {
948 	return setup_sparse_fiemap(a, entry, fd);
949 }
950 #endif
951 #endif	/* defined(HAVE_LINUX_FIEMAP_H) */
952 
953 #if defined(SEEK_HOLE) && defined(SEEK_DATA)
954 
955 /*
956  * SEEK_HOLE sparse interface (FreeBSD, Linux, Solaris)
957  */
958 
959 static int
setup_sparse(struct archive_read_disk * a,struct archive_entry * entry,int * fd)960 setup_sparse(struct archive_read_disk *a,
961     struct archive_entry *entry, int *fd)
962 {
963 	int64_t size;
964 	off_t initial_off;
965 	off_t off_s, off_e;
966 	int exit_sts = ARCHIVE_OK;
967 	int check_fully_sparse = 0;
968 	const char *path;
969 
970 	if (archive_entry_filetype(entry) != AE_IFREG
971 	    || archive_entry_size(entry) <= 0
972 	    || archive_entry_hardlink(entry) != NULL)
973 		return (ARCHIVE_OK);
974 
975 	/* Does filesystem support the reporting of hole ? */
976 	if (*fd < 0)
977 		path = archive_read_disk_entry_setup_path(a, entry, fd);
978 	else
979 		path = NULL;
980 
981 	if (*fd >= 0) {
982 #ifdef _PC_MIN_HOLE_SIZE
983 		if (fpathconf(*fd, _PC_MIN_HOLE_SIZE) <= 0)
984 			return (ARCHIVE_OK);
985 #endif
986 		initial_off = lseek(*fd, 0, SEEK_CUR);
987 		if (initial_off != 0)
988 			lseek(*fd, 0, SEEK_SET);
989 	} else {
990 		if (path == NULL)
991 			return (ARCHIVE_FAILED);
992 #ifdef _PC_MIN_HOLE_SIZE
993 		if (pathconf(path, _PC_MIN_HOLE_SIZE) <= 0)
994 			return (ARCHIVE_OK);
995 #endif
996 		*fd = open(path, O_RDONLY | O_NONBLOCK | O_CLOEXEC);
997 		if (*fd < 0) {
998 			archive_set_error(&a->archive, errno,
999 			    "Can't open `%s'", path);
1000 			return (ARCHIVE_FAILED);
1001 		}
1002 		__archive_ensure_cloexec_flag(*fd);
1003 		initial_off = 0;
1004 	}
1005 
1006 #ifndef _PC_MIN_HOLE_SIZE
1007 	/* Check if the underlying filesystem supports seek hole */
1008 	off_s = lseek(*fd, 0, SEEK_HOLE);
1009 	if (off_s < 0)
1010 #if defined(HAVE_LINUX_FIEMAP_H)
1011 		return setup_sparse_fiemap(a, entry, fd);
1012 #else
1013 		goto exit_setup_sparse;
1014 #endif
1015 	else if (off_s > 0)
1016 		lseek(*fd, 0, SEEK_SET);
1017 #endif
1018 
1019 	off_s = 0;
1020 	size = archive_entry_size(entry);
1021 	while (off_s < size) {
1022 		off_s = lseek(*fd, off_s, SEEK_DATA);
1023 		if (off_s == (off_t)-1) {
1024 			if (errno == ENXIO) {
1025 				/* no more hole */
1026 				if (archive_entry_sparse_count(entry) == 0) {
1027 					/* Potentially a fully-sparse file. */
1028 					check_fully_sparse = 1;
1029 				}
1030 				break;
1031 			}
1032 			archive_set_error(&a->archive, errno,
1033 			    "lseek(SEEK_HOLE) failed");
1034 			exit_sts = ARCHIVE_FAILED;
1035 			goto exit_setup_sparse;
1036 		}
1037 		off_e = lseek(*fd, off_s, SEEK_HOLE);
1038 		if (off_e == (off_t)-1) {
1039 			if (errno == ENXIO) {
1040 				off_e = lseek(*fd, 0, SEEK_END);
1041 				if (off_e != (off_t)-1)
1042 					break;/* no more data */
1043 			}
1044 			archive_set_error(&a->archive, errno,
1045 			    "lseek(SEEK_DATA) failed");
1046 			exit_sts = ARCHIVE_FAILED;
1047 			goto exit_setup_sparse;
1048 		}
1049 		if (off_s == 0 && off_e == size)
1050 			break;/* This is not sparse. */
1051 		archive_entry_sparse_add_entry(entry, off_s,
1052 			off_e - off_s);
1053 		off_s = off_e;
1054 	}
1055 
1056 	if (check_fully_sparse) {
1057 		if (lseek(*fd, 0, SEEK_HOLE) == 0 &&
1058 			lseek(*fd, 0, SEEK_END) == size) {
1059 			/* Fully sparse file; insert a zero-length "data" entry */
1060 			archive_entry_sparse_add_entry(entry, 0, 0);
1061 		}
1062 	}
1063 exit_setup_sparse:
1064 	lseek(*fd, initial_off, SEEK_SET);
1065 	return (exit_sts);
1066 }
1067 
1068 #elif !defined(HAVE_LINUX_FIEMAP_H)
1069 
1070 /*
1071  * Generic (stub) sparse support.
1072  */
1073 static int
setup_sparse(struct archive_read_disk * a,struct archive_entry * entry,int * fd)1074 setup_sparse(struct archive_read_disk *a,
1075     struct archive_entry *entry, int *fd)
1076 {
1077 	(void)a;     /* UNUSED */
1078 	(void)entry; /* UNUSED */
1079 	(void)fd;    /* UNUSED */
1080 	return (ARCHIVE_OK);
1081 }
1082 
1083 #endif
1084 
1085 #endif /* !defined(_WIN32) || defined(__CYGWIN__) */
1086 
1087