2 * Copyright (c) 2003-2007 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer
10 * in this position and unchanged.
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.
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.
27 #include "archive_platform.h"
28 __FBSDID("$FreeBSD$");
30 #ifdef HAVE_SYS_TYPES_H
31 #include <sys/types.h>
36 #ifdef HAVE_ATTR_XATTR_H
37 #include <attr/xattr.h>
39 #ifdef HAVE_SYS_IOCTL_H
40 #include <sys/ioctl.h>
42 #ifdef HAVE_SYS_STAT_H
45 #ifdef HAVE_SYS_TIME_H
49 #ifdef HAVE_EXT2FS_EXT2_FS_H
50 #include <ext2fs/ext2_fs.h> /* for Linux file flags */
61 #ifdef HAVE_LINUX_FS_H
62 #include <linux/fs.h> /* for Linux file flags */
64 #ifdef HAVE_LINUX_EXT2_FS_H
65 #include <linux/ext2_fs.h> /* for Linux file flags */
88 #include "archive_string.h"
89 #include "archive_entry.h"
90 #include "archive_private.h"
93 struct fixup_entry *next;
97 unsigned long mtime_nanos;
98 unsigned long atime_nanos;
99 unsigned long fflags_set;
100 int fixup; /* bitmask of what needs fixing */
105 * We use a bitmask to track which operations remain to be done for
106 * this file. In particular, this helps us avoid unnecessary
107 * operations when it's possible to take care of one step as a
108 * side-effect of another. For example, mkdir() can specify the mode
109 * for the newly-created object but symlink() cannot. This means we
110 * can skip chmod() if mkdir() succeeded, but we must explicitly
111 * chmod() if we're trying to create a directory that already exists
112 * (mkdir() failed) or if we're restoring a symlink. Similarly, we
113 * need to verify UID/GID before trying to restore SUID/SGID bits;
114 * that verification can occur explicitly through a stat() call or
115 * implicitly because of a successful chown() call.
117 #define TODO_MODE_FORCE 0x40000000
118 #define TODO_MODE_BASE 0x20000000
119 #define TODO_SUID 0x10000000
120 #define TODO_SUID_CHECK 0x08000000
121 #define TODO_SGID 0x04000000
122 #define TODO_SGID_CHECK 0x02000000
123 #define TODO_MODE (TODO_MODE_BASE|TODO_SUID|TODO_SGID)
124 #define TODO_TIMES ARCHIVE_EXTRACT_TIME
125 #define TODO_OWNER ARCHIVE_EXTRACT_OWNER
126 #define TODO_FFLAGS ARCHIVE_EXTRACT_FFLAGS
127 #define TODO_ACLS ARCHIVE_EXTRACT_ACL
128 #define TODO_XATTR ARCHIVE_EXTRACT_XATTR
130 struct archive_write_disk {
131 struct archive archive;
134 struct fixup_entry *fixup_list;
135 struct fixup_entry *current_fixup;
140 gid_t (*lookup_gid)(void *private, const char *gname, gid_t gid);
141 void (*cleanup_gid)(void *private);
142 void *lookup_gid_data;
143 uid_t (*lookup_uid)(void *private, const char *gname, gid_t gid);
144 void (*cleanup_uid)(void *private);
145 void *lookup_uid_data;
148 * Full path of last file to satisfy symlink checks.
150 struct archive_string path_safe;
153 * Cached stat data from disk for the current entry.
154 * If this is valid, pst points to st. Otherwise,
160 /* Information about the object being restored right now. */
161 struct archive_entry *entry; /* Entry being extracted. */
162 char *name; /* Name of entry, possibly edited. */
163 struct archive_string _name_data; /* backing store for 'name' */
164 /* Tasks remaining for this object. */
166 /* Tasks deferred until end-of-archive. */
168 /* Options requested by the client. */
170 /* Handle for the file we're restoring. */
172 /* Current offset for writing data to the file. */
174 /* Dir we were in before this restore; only for deep paths. */
176 /* Mode we should use for this entry; affected by _PERM and umask. */
178 /* UID/GID to use in restoring this entry. */
184 * Default mode for dirs created automatically (will be modified by umask).
185 * Note that POSIX specifies 0777 for implicity-created dirs, "modified
186 * by the process' file creation mask."
188 #define DEFAULT_DIR_MODE 0777
190 * Dir modes are restored in two steps: During the extraction, the permissions
191 * in the archive are modified to match the following limits. During
192 * the post-extract fixup pass, the permissions from the archive are
195 #define MINIMUM_DIR_MODE 0700
196 #define MAXIMUM_DIR_MODE 0775
198 static int check_symlinks(struct archive_write_disk *);
199 static int create_filesystem_object(struct archive_write_disk *);
200 static struct fixup_entry *current_fixup(struct archive_write_disk *, const char *pathname);
202 static void edit_deep_directories(struct archive_write_disk *ad);
204 static int cleanup_pathname(struct archive_write_disk *);
205 static int create_dir(struct archive_write_disk *, char *);
206 static int create_parent_dir(struct archive_write_disk *, char *);
207 static int older(struct stat *, struct archive_entry *);
208 static int restore_entry(struct archive_write_disk *);
209 #ifdef HAVE_POSIX_ACL
210 static int set_acl(struct archive_write_disk *, int fd, struct archive_entry *,
211 acl_type_t, int archive_entry_acl_type, const char *tn);
213 static int set_acls(struct archive_write_disk *);
214 static int set_xattrs(struct archive_write_disk *);
215 static int set_fflags(struct archive_write_disk *);
216 static int set_fflags_platform(struct archive_write_disk *, int fd,
217 const char *name, mode_t mode,
218 unsigned long fflags_set, unsigned long fflags_clear);
219 static int set_ownership(struct archive_write_disk *);
220 static int set_mode(struct archive_write_disk *, int mode);
221 static int set_time(struct archive_write_disk *);
222 static struct fixup_entry *sort_dir_list(struct fixup_entry *p);
223 static gid_t trivial_lookup_gid(void *, const char *, gid_t);
224 static uid_t trivial_lookup_uid(void *, const char *, uid_t);
227 static struct archive_vtable *archive_write_disk_vtable(void);
229 static int _archive_write_close(struct archive *);
230 static int _archive_write_finish(struct archive *);
231 static int _archive_write_header(struct archive *, struct archive_entry *);
232 static int _archive_write_finish_entry(struct archive *);
233 static ssize_t _archive_write_data(struct archive *, const void *, size_t);
234 static ssize_t _archive_write_data_block(struct archive *, const void *, size_t, off_t);
236 static struct archive_vtable *
237 archive_write_disk_vtable(void)
239 static struct archive_vtable av;
240 static int inited = 0;
243 av.archive_write_close = _archive_write_close;
244 av.archive_write_finish = _archive_write_finish;
245 av.archive_write_header = _archive_write_header;
246 av.archive_write_finish_entry = _archive_write_finish_entry;
247 av.archive_write_data = _archive_write_data;
248 av.archive_write_data_block = _archive_write_data_block;
255 archive_write_disk_set_options(struct archive *_a, int flags)
257 struct archive_write_disk *a = (struct archive_write_disk *)_a;
265 * Extract this entry to disk.
267 * TODO: Validate hardlinks. According to the standards, we're
268 * supposed to check each extracted hardlink and squawk if it refers
269 * to a file that we didn't restore. I'm not entirely convinced this
270 * is a good idea, but more importantly: Is there any way to validate
271 * hardlinks without keeping a complete list of filenames from the
272 * entire archive?? Ugh.
276 _archive_write_header(struct archive *_a, struct archive_entry *entry)
278 struct archive_write_disk *a = (struct archive_write_disk *)_a;
279 struct fixup_entry *fe;
282 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
283 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
284 "archive_write_disk_header");
285 archive_clear_error(&a->archive);
286 if (a->archive.state & ARCHIVE_STATE_DATA) {
287 r = _archive_write_finish_entry(&a->archive);
292 /* Set up for this particular entry. */
294 a->current_fixup = NULL;
297 archive_entry_free(a->entry);
300 a->entry = archive_entry_clone(entry);
303 a->uid = a->user_uid;
304 a->mode = archive_entry_mode(a->entry);
305 archive_strcpy(&(a->_name_data), archive_entry_pathname(a->entry));
306 a->name = a->_name_data.s;
307 archive_clear_error(&a->archive);
310 * Clean up the requested path. This is necessary for correct
311 * dir restores; the dir restore logic otherwise gets messed
312 * up by nonsense like "dir/.".
314 ret = cleanup_pathname(a);
315 if (ret != ARCHIVE_OK)
319 * Set the umask to zero so we get predictable mode settings.
320 * This gets done on every call to _write_header in case the
321 * user edits their umask during the extraction for some
322 * reason. This will be reset before we return. Note that we
323 * don't need to do this in _finish_entry, as the chmod(), etc,
324 * system calls don't obey umask.
326 a->user_umask = umask(0);
327 /* From here on, early exit requires "goto done" to clean up. */
329 /* Figure out what we need to do for this entry. */
330 a->todo = TODO_MODE_BASE;
331 if (a->flags & ARCHIVE_EXTRACT_PERM) {
332 a->todo |= TODO_MODE_FORCE; /* Be pushy about permissions. */
334 * SGID requires an extra "check" step because we
335 * cannot easily predict the GID that the system will
336 * assign. (Different systems assign GIDs to files
337 * based on a variety of criteria, including process
338 * credentials and the gid of the enclosing
339 * directory.) We can only restore the SGID bit if
340 * the file has the right GID, and we only know the
341 * GID if we either set it (see set_ownership) or if
342 * we've actually called stat() on the file after it
343 * was restored. Since there are several places at
344 * which we might verify the GID, we need a TODO bit
347 if (a->mode & S_ISGID)
348 a->todo |= TODO_SGID | TODO_SGID_CHECK;
350 * Verifying the SUID is simpler, but can still be
351 * done in multiple ways, hence the separate "check" bit.
353 if (a->mode & S_ISUID)
354 a->todo |= TODO_SUID | TODO_SUID_CHECK;
357 * User didn't request full permissions, so don't
358 * restore SUID, SGID bits and obey umask.
363 a->mode &= ~a->user_umask;
365 if (a->flags & ARCHIVE_EXTRACT_OWNER)
366 a->todo |= TODO_OWNER;
367 if (a->flags & ARCHIVE_EXTRACT_TIME)
368 a->todo |= TODO_TIMES;
369 if (a->flags & ARCHIVE_EXTRACT_ACL)
370 a->todo |= TODO_ACLS;
371 if (a->flags & ARCHIVE_EXTRACT_FFLAGS)
372 a->todo |= TODO_FFLAGS;
373 if (a->flags & ARCHIVE_EXTRACT_SECURE_SYMLINKS) {
374 ret = check_symlinks(a);
375 if (ret != ARCHIVE_OK)
379 /* If path exceeds PATH_MAX, shorten the path. */
380 edit_deep_directories(a);
383 ret = restore_entry(a);
386 /* If we changed directory above, restore it here. */
387 if (a->restore_pwd >= 0) {
388 fchdir(a->restore_pwd);
389 close(a->restore_pwd);
395 * Fixup uses the unedited pathname from archive_entry_pathname(),
396 * because it is relative to the base dir and the edited path
397 * might be relative to some intermediate dir as a result of the
398 * deep restore logic.
400 if (a->deferred & TODO_MODE) {
401 fe = current_fixup(a, archive_entry_pathname(entry));
402 fe->fixup |= TODO_MODE_BASE;
406 if (a->deferred & TODO_TIMES) {
407 fe = current_fixup(a, archive_entry_pathname(entry));
408 fe->fixup |= TODO_TIMES;
409 fe->mtime = archive_entry_mtime(entry);
410 fe->mtime_nanos = archive_entry_mtime_nsec(entry);
411 fe->atime = archive_entry_atime(entry);
412 fe->atime_nanos = archive_entry_atime_nsec(entry);
415 if (a->deferred & TODO_FFLAGS) {
416 fe = current_fixup(a, archive_entry_pathname(entry));
417 fe->fixup |= TODO_FFLAGS;
418 /* TODO: Complete this.. defer fflags from below. */
421 /* We've created the object and are ready to pour data into it. */
422 if (ret == ARCHIVE_OK)
423 a->archive.state = ARCHIVE_STATE_DATA;
425 /* Restore the user's umask before returning. */
426 umask(a->user_umask);
432 archive_write_disk_set_skip_file(struct archive *_a, dev_t d, ino_t i)
434 struct archive_write_disk *a = (struct archive_write_disk *)_a;
435 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
436 ARCHIVE_STATE_ANY, "archive_write_disk_set_skip_file");
437 a->skip_file_dev = d;
438 a->skip_file_ino = i;
443 _archive_write_data_block(struct archive *_a,
444 const void *buff, size_t size, off_t offset)
446 struct archive_write_disk *a = (struct archive_write_disk *)_a;
447 ssize_t bytes_written = 0;
449 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
450 ARCHIVE_STATE_DATA, "archive_write_disk_block");
453 archive_clear_error(&a->archive);
455 /* Seek if necessary to the specified offset. */
456 if (offset != a->offset) {
457 if (lseek(a->fd, offset, SEEK_SET) < 0) {
458 archive_set_error(&a->archive, errno, "Seek failed");
459 return (ARCHIVE_WARN);
464 /* Write the data. */
466 bytes_written = write(a->fd, buff, size);
467 if (bytes_written < 0) {
468 archive_set_error(&a->archive, errno, "Write failed");
469 return (ARCHIVE_WARN);
471 size -= bytes_written;
472 a->offset += bytes_written;
478 _archive_write_data(struct archive *_a, const void *buff, size_t size)
480 struct archive_write_disk *a = (struct archive_write_disk *)_a;
481 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
482 ARCHIVE_STATE_DATA, "archive_write_data");
486 return (_archive_write_data_block(_a, buff, size, a->offset));
490 _archive_write_finish_entry(struct archive *_a)
492 struct archive_write_disk *a = (struct archive_write_disk *)_a;
493 int ret = ARCHIVE_OK;
495 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
496 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
497 "archive_write_finish_entry");
498 if (a->archive.state & ARCHIVE_STATE_HEADER)
500 archive_clear_error(&a->archive);
502 /* Restore metadata. */
505 * Look up the "real" UID only if we're going to need it. We
506 * need this for TODO_SGID because chown() requires both.
508 if (a->todo & (TODO_OWNER | TODO_SUID | TODO_SGID)) {
509 a->uid = a->lookup_uid(a->lookup_uid_data,
510 archive_entry_uname(a->entry),
511 archive_entry_uid(a->entry));
513 /* Look up the "real" GID only if we're going to need it. */
514 if (a->todo & (TODO_OWNER | TODO_SGID | TODO_SUID)) {
515 a->gid = a->lookup_gid(a->lookup_gid_data,
516 archive_entry_gname(a->entry),
517 archive_entry_gid(a->entry));
520 * If restoring ownership, do it before trying to restore suid/sgid
521 * bits. If we set the owner, we know what it is and can skip
522 * a stat() call to examine the ownership of the file on disk.
524 if (a->todo & TODO_OWNER)
525 ret = set_ownership(a);
526 if (a->todo & TODO_MODE) {
527 int r2 = set_mode(a, a->mode);
528 if (r2 < ret) ret = r2;
530 if (a->todo & TODO_TIMES) {
531 int r2 = set_time(a);
532 if (r2 < ret) ret = r2;
534 if (a->todo & TODO_ACLS) {
535 int r2 = set_acls(a);
536 if (r2 < ret) ret = r2;
538 if (a->todo & TODO_XATTR) {
539 int r2 = set_xattrs(a);
540 if (r2 < ret) ret = r2;
542 if (a->todo & TODO_FFLAGS) {
543 int r2 = set_fflags(a);
544 if (r2 < ret) ret = r2;
547 /* If there's an fd, we can close it now. */
552 /* If there's an entry, we can release it now. */
554 archive_entry_free(a->entry);
557 a->archive.state = ARCHIVE_STATE_HEADER;
562 archive_write_disk_set_group_lookup(struct archive *_a,
564 gid_t (*lookup_gid)(void *private, const char *gname, gid_t gid),
565 void (*cleanup_gid)(void *private))
567 struct archive_write_disk *a = (struct archive_write_disk *)_a;
568 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
569 ARCHIVE_STATE_ANY, "archive_write_disk_set_group_lookup");
571 a->lookup_gid = lookup_gid;
572 a->cleanup_gid = cleanup_gid;
573 a->lookup_gid_data = private_data;
578 archive_write_disk_set_user_lookup(struct archive *_a,
580 uid_t (*lookup_uid)(void *private, const char *uname, uid_t uid),
581 void (*cleanup_uid)(void *private))
583 struct archive_write_disk *a = (struct archive_write_disk *)_a;
584 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
585 ARCHIVE_STATE_ANY, "archive_write_disk_set_user_lookup");
587 a->lookup_uid = lookup_uid;
588 a->cleanup_uid = cleanup_uid;
589 a->lookup_uid_data = private_data;
595 * Create a new archive_write_disk object and initialize it with global state.
598 archive_write_disk_new(void)
600 struct archive_write_disk *a;
602 a = (struct archive_write_disk *)malloc(sizeof(*a));
605 memset(a, 0, sizeof(*a));
606 a->archive.magic = ARCHIVE_WRITE_DISK_MAGIC;
607 /* We're ready to write a header immediately. */
608 a->archive.state = ARCHIVE_STATE_HEADER;
609 a->archive.vtable = archive_write_disk_vtable();
610 a->lookup_uid = trivial_lookup_uid;
611 a->lookup_gid = trivial_lookup_gid;
612 a->user_uid = geteuid();
613 if (archive_string_ensure(&a->path_safe, 512) == NULL) {
617 return (&a->archive);
622 * If pathname is longer than PATH_MAX, chdir to a suitable
623 * intermediate dir and edit the path down to a shorter suffix. Note
624 * that this routine never returns an error; if the chdir() attempt
625 * fails for any reason, we just go ahead with the long pathname. The
626 * object creation is likely to fail, but any error will get handled
631 edit_deep_directories(struct archive_write_disk *a)
634 char *tail = a->name;
638 /* If path is short, avoid the open() below. */
639 if (strlen(tail) <= PATH_MAX)
642 /* Try to record our starting dir. */
643 a->restore_pwd = open(".", O_RDONLY);
644 if (a->restore_pwd < 0)
647 /* As long as the path is too long... */
648 while (strlen(tail) > PATH_MAX) {
649 /* Locate a dir prefix shorter than PATH_MAX. */
650 tail += PATH_MAX - 8;
651 while (tail > a->name && *tail != '/')
653 /* Exit if we find a too-long path component. */
656 /* Create the intermediate dir and chdir to it. */
657 *tail = '\0'; /* Terminate dir portion */
658 ret = create_dir(a, a->name);
659 if (ret == ARCHIVE_OK && chdir(a->name) != 0)
661 *tail = '/'; /* Restore the / we removed. */
662 if (ret != ARCHIVE_OK)
665 /* The chdir() succeeded; we've now shortened the path. */
673 * The main restore function.
676 restore_entry(struct archive_write_disk *a)
678 int ret = ARCHIVE_OK, en;
680 if (a->flags & ARCHIVE_EXTRACT_UNLINK && !S_ISDIR(a->mode)) {
681 if (unlink(a->name) == 0) {
682 /* We removed it, we're done. */
683 } else if (errno == ENOENT) {
684 /* File didn't exist, that's just as good. */
685 } else if (rmdir(a->name) == 0) {
686 /* It was a dir, but now it's gone. */
688 /* We tried, but couldn't get rid of it. */
689 archive_set_error(&a->archive, errno,
691 return(ARCHIVE_WARN);
695 /* Try creating it first; if this fails, we'll try to recover. */
696 en = create_filesystem_object(a);
698 if ((en == ENOTDIR || en == ENOENT)
699 && !(a->flags & ARCHIVE_EXTRACT_NO_AUTODIR)) {
700 /* If the parent dir doesn't exist, try creating it. */
701 create_parent_dir(a, a->name);
702 /* Now try to create the object again. */
703 en = create_filesystem_object(a);
706 if ((en == EISDIR || en == EEXIST)
707 && (a->flags & ARCHIVE_EXTRACT_NO_OVERWRITE)) {
708 /* If we're not overwriting, we're done. */
709 archive_set_error(&a->archive, en, "Already exists");
710 return (ARCHIVE_WARN);
714 * Some platforms return EISDIR if you call
715 * open(O_WRONLY | O_EXCL | O_CREAT) on a directory, some
716 * return EEXIST. POSIX is ambiguous, requiring EISDIR
717 * for open(O_WRONLY) on a dir and EEXIST for open(O_EXCL | O_CREAT)
718 * on an existing item.
721 /* A dir is in the way of a non-dir, rmdir it. */
722 if (rmdir(a->name) != 0) {
723 archive_set_error(&a->archive, errno,
724 "Can't remove already-existing dir");
725 return (ARCHIVE_WARN);
728 en = create_filesystem_object(a);
729 } else if (en == EEXIST) {
731 * We know something is in the way, but we don't know what;
732 * we need to find out before we go any further.
734 if (lstat(a->name, &a->st) != 0) {
735 archive_set_error(&a->archive, errno,
736 "Can't stat existing object");
737 return (ARCHIVE_WARN);
740 /* TODO: if it's a symlink... */
742 if (a->flags & ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER) {
743 if (!older(&(a->st), a->entry)) {
744 archive_set_error(&a->archive, 0,
745 "File on disk is not older; skipping.");
746 return (ARCHIVE_FAILED);
750 /* If it's our archive, we're done. */
751 if (a->skip_file_dev > 0 &&
752 a->skip_file_ino > 0 &&
753 a->st.st_dev == a->skip_file_dev &&
754 a->st.st_ino == a->skip_file_ino) {
755 archive_set_error(&a->archive, 0, "Refusing to overwrite archive");
756 return (ARCHIVE_FAILED);
759 if (!S_ISDIR(a->st.st_mode)) {
760 /* A non-dir is in the way, unlink it. */
761 if (unlink(a->name) != 0) {
762 archive_set_error(&a->archive, errno,
763 "Can't unlink already-existing object");
764 return (ARCHIVE_WARN);
767 en = create_filesystem_object(a);
768 } else if (!S_ISDIR(a->mode)) {
769 /* A dir is in the way of a non-dir, rmdir it. */
770 if (rmdir(a->name) != 0) {
771 archive_set_error(&a->archive, errno,
772 "Can't remove already-existing dir");
773 return (ARCHIVE_WARN);
776 en = create_filesystem_object(a);
779 * There's a dir in the way of a dir. Don't
780 * waste time with rmdir()/mkdir(), just fix
781 * up the permissions on the existing dir.
782 * Note that we don't change perms on existing
783 * dirs unless _EXTRACT_PERM is specified.
785 if ((a->mode != a->st.st_mode)
786 && (a->todo & TODO_MODE_FORCE))
787 a->deferred |= (a->todo & TODO_MODE);
788 /* Ownership doesn't need deferred fixup. */
789 en = 0; /* Forget the EEXIST. */
794 /* Everything failed; give up here. */
795 archive_set_error(&a->archive, en, "Can't create '%s'", a->name);
796 return (ARCHIVE_WARN);
799 a->pst = NULL; /* Cached stat data no longer valid. */
804 * Returns 0 if creation succeeds, or else returns errno value from
805 * the failed system call. Note: This function should only ever perform
806 * a single system call.
809 create_filesystem_object(struct archive_write_disk *a)
811 /* Create the entry. */
812 const char *linkname;
813 mode_t final_mode, mode;
816 /* We identify hard/symlinks according to the link names. */
817 /* Since link(2) and symlink(2) don't handle modes, we're done here. */
818 linkname = archive_entry_hardlink(a->entry);
819 if (linkname != NULL)
820 return link(linkname, a->name) ? errno : 0;
821 linkname = archive_entry_symlink(a->entry);
822 if (linkname != NULL)
823 return symlink(linkname, a->name) ? errno : 0;
826 * The remaining system calls all set permissions, so let's
827 * try to take advantage of that to avoid an extra chmod()
828 * call. (Recall that umask is set to zero right now!)
831 /* Mode we want for the final restored object (w/o file type bits). */
832 final_mode = a->mode & 07777;
834 * The mode that will actually be restored in this step. Note
835 * that SUID, SGID, etc, require additional work to ensure
836 * security, so we never restore them at this point.
838 mode = final_mode & 0777;
840 switch (a->mode & S_IFMT) {
842 /* POSIX requires that we fall through here. */
845 a->fd = open(a->name,
846 O_WRONLY | O_CREAT | O_EXCL, mode);
850 r = mknod(a->name, mode | S_IFCHR,
851 archive_entry_rdev(a->entry));
854 r = mknod(a->name, mode | S_IFBLK,
855 archive_entry_rdev(a->entry));
858 mode = (mode | MINIMUM_DIR_MODE) & MAXIMUM_DIR_MODE;
859 r = mkdir(a->name, mode);
861 /* Defer setting dir times. */
862 a->deferred |= (a->todo & TODO_TIMES);
863 a->todo &= ~TODO_TIMES;
864 /* Never use an immediate chmod(). */
865 if (mode != final_mode)
866 a->deferred |= (a->todo & TODO_MODE);
867 a->todo &= ~TODO_MODE;
871 r = mkfifo(a->name, mode);
875 /* All the system calls above set errno on failure. */
879 /* If we managed to set the final mode, we've avoided a chmod(). */
880 if (mode == final_mode)
881 a->todo &= ~TODO_MODE;
886 * Cleanup function for archive_extract. Mostly, this involves processing
887 * the fixup list, which is used to address a number of problems:
888 * * Dir permissions might prevent us from restoring a file in that
889 * dir, so we restore the dir with minimum 0700 permissions first,
890 * then correct the mode at the end.
891 * * Similarly, the act of restoring a file touches the directory
892 * and changes the timestamp on the dir, so we have to touch-up dir
893 * timestamps at the end as well.
894 * * Some file flags can interfere with the restore by, for example,
895 * preventing the creation of hardlinks to those files.
897 * Note that tar/cpio do not require that archives be in a particular
898 * order; there is no way to know when the last file has been restored
899 * within a directory, so there's no way to optimize the memory usage
900 * here by fixing up the directory any earlier than the
903 * XXX TODO: Directory ACLs should be restored here, for the same
904 * reason we set directory perms here. XXX
907 _archive_write_close(struct archive *_a)
909 struct archive_write_disk *a = (struct archive_write_disk *)_a;
910 struct fixup_entry *next, *p;
913 __archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
914 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
915 "archive_write_disk_close");
916 ret = _archive_write_finish_entry(&a->archive);
918 /* Sort dir list so directories are fixed up in depth-first order. */
919 p = sort_dir_list(a->fixup_list);
922 a->pst = NULL; /* Mark stat cache as out-of-date. */
923 if (p->fixup & TODO_TIMES) {
925 /* {f,l,}utimes() are preferred, when available. */
926 struct timeval times[2];
927 times[1].tv_sec = p->mtime;
928 times[1].tv_usec = p->mtime_nanos / 1000;
929 times[0].tv_sec = p->atime;
930 times[0].tv_usec = p->atime_nanos / 1000;
932 lutimes(p->name, times);
934 utimes(p->name, times);
937 /* utime() is more portable, but less precise. */
938 struct utimbuf times;
939 times.modtime = p->mtime;
940 times.actime = p->atime;
942 utime(p->name, ×);
945 if (p->fixup & TODO_MODE_BASE)
946 chmod(p->name, p->mode);
948 if (p->fixup & TODO_FFLAGS)
949 set_fflags_platform(a, -1, p->name,
950 p->mode, p->fflags_set, 0);
957 a->fixup_list = NULL;
962 _archive_write_finish(struct archive *_a)
964 struct archive_write_disk *a = (struct archive_write_disk *)_a;
966 ret = _archive_write_close(&a->archive);
967 if (a->cleanup_gid != NULL && a->lookup_gid_data != NULL)
968 (a->cleanup_gid)(a->lookup_gid_data);
969 if (a->cleanup_uid != NULL && a->lookup_uid_data != NULL)
970 (a->cleanup_uid)(a->lookup_uid_data);
971 archive_string_free(&a->_name_data);
972 archive_string_free(&a->archive.error_string);
973 archive_string_free(&a->path_safe);
979 * Simple O(n log n) merge sort to order the fixup list. In
980 * particular, we want to restore dir timestamps depth-first.
982 static struct fixup_entry *
983 sort_dir_list(struct fixup_entry *p)
985 struct fixup_entry *a, *b, *t;
989 /* A one-item list is already sorted. */
993 /* Step 1: split the list. */
997 /* Step a twice, t once. */
1003 /* Now, t is at the mid-point, so break the list here. */
1008 /* Step 2: Recursively sort the two sub-lists. */
1009 a = sort_dir_list(a);
1010 b = sort_dir_list(b);
1012 /* Step 3: Merge the returned lists. */
1013 /* Pick the first element for the merged list. */
1014 if (strcmp(a->name, b->name) > 0) {
1022 /* Always put the later element on the list first. */
1023 while (a != NULL && b != NULL) {
1024 if (strcmp(a->name, b->name) > 0) {
1034 /* Only one list is non-empty, so just splice it on. */
1044 * Returns a new, initialized fixup entry.
1046 * TODO: Reduce the memory requirements for this list by using a tree
1047 * structure rather than a simple list of names.
1049 static struct fixup_entry *
1050 new_fixup(struct archive_write_disk *a, const char *pathname)
1052 struct fixup_entry *fe;
1054 fe = (struct fixup_entry *)malloc(sizeof(struct fixup_entry));
1057 fe->next = a->fixup_list;
1060 fe->name = strdup(pathname);
1065 * Returns a fixup structure for the current entry.
1067 static struct fixup_entry *
1068 current_fixup(struct archive_write_disk *a, const char *pathname)
1070 if (a->current_fixup == NULL)
1071 a->current_fixup = new_fixup(a, pathname);
1072 return (a->current_fixup);
1075 /* TODO: Make this work. */
1077 * TODO: The deep-directory support bypasses this; disable deep directory
1078 * support if we're doing symlink checks.
1081 * TODO: Someday, integrate this with the deep dir support; they both
1082 * scan the path and both can be optimized by comparing against other
1086 check_symlinks(struct archive_write_disk *a)
1094 * Gaurd against symlink tricks. Reject any archive entry whose
1095 * destination would be altered by a symlink.
1097 /* Whatever we checked last time doesn't need to be re-checked. */
1100 while ((*pn != '\0') && (*p == *pn))
1103 /* Keep going until we've checked the entire name. */
1104 while (pn[0] != '\0' && (pn[0] != '/' || pn[1] != '\0')) {
1105 /* Skip the next path element. */
1106 while (*pn != '\0' && *pn != '/')
1110 /* Check that we haven't hit a symlink. */
1111 r = lstat(a->name, &st);
1113 /* We've hit a dir that doesn't exist; stop now. */
1114 if (errno == ENOENT)
1116 } else if (S_ISLNK(st.st_mode)) {
1119 * Last element is symlink; remove it
1120 * so we can overwrite it with the
1121 * item being extracted.
1123 if (unlink(a->name)) {
1124 archive_set_error(&a->archive, errno,
1125 "Could not remove symlink %s",
1128 return (ARCHIVE_WARN);
1131 * Even if we did remove it, a warning
1132 * is in order. The warning is silly,
1133 * though, if we're just replacing one
1134 * symlink with another symlink.
1136 if (!S_ISLNK(a->mode)) {
1137 archive_set_error(&a->archive, 0,
1138 "Removing symlink %s",
1141 /* Symlink gone. No more problem! */
1144 } else if (a->flags & ARCHIVE_EXTRACT_UNLINK) {
1145 /* User asked us to remove problems. */
1146 if (unlink(a->name) != 0) {
1147 archive_set_error(&a->archive, 0,
1148 "Cannot remove intervening symlink %s",
1151 return (ARCHIVE_WARN);
1154 archive_set_error(&a->archive, 0,
1155 "Cannot extract through symlink %s",
1158 return (ARCHIVE_WARN);
1163 /* We've checked and/or cleaned the whole path, so remember it. */
1164 archive_strcpy(&a->path_safe, a->name);
1165 return (ARCHIVE_OK);
1169 * Canonicalize the pathname. In particular, this strips duplicate
1170 * '/' characters, '.' elements, and trailing '/'. It also raises an
1171 * error for an empty path, a trailing '..' or (if _SECURE_NODOTDOT is
1172 * set) any '..' in the path.
1175 cleanup_pathname(struct archive_write_disk *a)
1178 char separator = '\0';
1179 int lastdotdot = 0; /* True if last elt copied was '..' */
1181 dest = src = a->name;
1183 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1184 "Invalid empty pathname");
1185 return (ARCHIVE_WARN);
1188 /* Skip leading '/'. */
1192 /* Scan the pathname one element at a time. */
1194 /* src points to first char after '/' */
1195 if (src[0] == '\0') {
1197 } else if (src[0] == '/') {
1198 /* Found '//', ignore second one. */
1201 } else if (src[0] == '.') {
1202 if (src[1] == '\0') {
1203 /* Ignore trailing '.' */
1205 } else if (src[1] == '/') {
1209 } else if (src[1] == '.') {
1210 if (src[2] == '/' || src[2] == '\0') {
1211 /* Conditionally warn about '..' */
1212 if (a->flags & ARCHIVE_EXTRACT_SECURE_NODOTDOT) {
1213 archive_set_error(&a->archive,
1215 "Path contains '..'");
1216 return (ARCHIVE_WARN);
1222 * Note: Under no circumstances do we
1223 * remove '..' elements. In
1224 * particular, restoring
1225 * '/foo/../bar/' should create the
1226 * 'foo' dir as a side-effect.
1233 /* Copy current element, including leading '/'. */
1236 while (*src != '\0' && *src != '/') {
1243 /* Skip '/' separator. */
1247 * We've just copied zero or more path elements, not including the
1251 /* Trailing '..' is always wrong. */
1252 archive_set_error(&a->archive,
1254 "Path contains trailing '..'");
1255 return (ARCHIVE_WARN);
1257 if (dest == a->name) {
1259 * Nothing got copied. The path must have been something
1260 * like '.' or '/' or './' or '/././././/./'.
1267 /* Terminate the result. */
1269 return (ARCHIVE_OK);
1273 * Create the parent directory of the specified path, assuming path
1274 * is already in mutable storage.
1277 create_parent_dir(struct archive_write_disk *a, char *path)
1282 /* Remove tail element to obtain parent name. */
1283 slash = strrchr(path, '/');
1285 return (ARCHIVE_OK);
1287 r = create_dir(a, path);
1293 * Create the specified dir, recursing to create parents as necessary.
1295 * Returns ARCHIVE_OK if the path exists when we're done here.
1296 * Otherwise, returns ARCHIVE_WARN.
1297 * Assumes path is in mutable storage; path is unchanged on exit.
1300 create_dir(struct archive_write_disk *a, char *path)
1303 struct fixup_entry *le;
1305 mode_t mode_final, mode;
1310 /* Check for special names and just skip them. */
1311 slash = strrchr(path, '/');
1317 if (base[0] == '\0' ||
1318 (base[0] == '.' && base[1] == '\0') ||
1319 (base[0] == '.' && base[1] == '.' && base[2] == '\0')) {
1320 /* Don't bother trying to create null path, '.', or '..'. */
1321 if (slash != NULL) {
1323 r = create_dir(a, path);
1327 return (ARCHIVE_OK);
1331 * Yes, this should be stat() and not lstat(). Using lstat()
1332 * here loses the ability to extract through symlinks. Also note
1333 * that this should not use the a->st cache.
1335 if (stat(path, &st) == 0) {
1336 if (S_ISDIR(st.st_mode))
1337 return (ARCHIVE_OK);
1338 if ((a->flags & ARCHIVE_EXTRACT_NO_OVERWRITE)) {
1339 archive_set_error(&a->archive, EEXIST,
1340 "Can't create directory '%s'", path);
1341 return (ARCHIVE_WARN);
1343 if (unlink(path) != 0) {
1344 archive_set_error(&a->archive, errno,
1345 "Can't create directory '%s': "
1346 "Conflicting file cannot be removed");
1347 return (ARCHIVE_WARN);
1349 } else if (errno != ENOENT && errno != ENOTDIR) {
1351 archive_set_error(&a->archive, errno, "Can't test directory '%s'", path);
1352 return (ARCHIVE_WARN);
1353 } else if (slash != NULL) {
1355 r = create_dir(a, path);
1357 if (r != ARCHIVE_OK)
1362 * Mode we want for the final restored directory. Per POSIX,
1363 * implicitly-created dirs must be created obeying the umask.
1364 * There's no mention whether this is different for privileged
1365 * restores (which the rest of this code handles by pretending
1366 * umask=0). I've chosen here to always obey the user's umask for
1367 * implicit dirs, even if _EXTRACT_PERM was specified.
1369 mode_final = DEFAULT_DIR_MODE & ~a->user_umask;
1370 /* Mode we want on disk during the restore process. */
1372 mode |= MINIMUM_DIR_MODE;
1373 mode &= MAXIMUM_DIR_MODE;
1374 if (mkdir(path, mode) == 0) {
1375 if (mode != mode_final) {
1376 le = new_fixup(a, path);
1377 le->fixup |=TODO_MODE_BASE;
1378 le->mode = mode_final;
1380 return (ARCHIVE_OK);
1384 * Without the following check, a/b/../b/c/d fails at the
1385 * second visit to 'b', so 'd' can't be created. Note that we
1386 * don't add it to the fixup list here, as it's already been
1389 if (stat(path, &st) == 0 && S_ISDIR(st.st_mode))
1390 return (ARCHIVE_OK);
1392 archive_set_error(&a->archive, errno, "Failed to create dir '%s'", path);
1393 return (ARCHIVE_WARN);
1397 * Note: Although we can skip setting the user id if the desired user
1398 * id matches the current user, we cannot skip setting the group, as
1399 * many systems set the gid bit based on the containing directory. So
1400 * we have to perform a chown syscall if we want to restore the SGID
1401 * bit. (The alternative is to stat() and then possibly chown(); it's
1402 * more efficient to skip the stat() and just always chown().) Note
1403 * that a successful chown() here clears the TODO_SGID_CHECK bit, which
1404 * allows set_mode to skip the stat() check for the GID.
1407 set_ownership(struct archive_write_disk *a)
1409 /* If we know we can't change it, don't bother trying. */
1410 if (a->user_uid != 0 && a->user_uid != a->uid) {
1411 archive_set_error(&a->archive, errno,
1412 "Can't set UID=%d", a->uid);
1413 return (ARCHIVE_WARN);
1417 if (a->fd >= 0 && fchown(a->fd, a->uid, a->gid) == 0)
1422 if (lchown(a->name, a->uid, a->gid) == 0)
1425 if (!S_ISLNK(a->mode) && chown(a->name, a->uid, a->gid) == 0)
1429 archive_set_error(&a->archive, errno,
1430 "Can't set user=%d/group=%d for %s", a->uid, a->gid,
1432 return (ARCHIVE_WARN);
1434 a->todo &= ~TODO_OWNER;
1435 /* We know the user/group are correct now. */
1436 a->todo &= ~TODO_SGID_CHECK;
1437 a->todo &= ~TODO_SUID_CHECK;
1438 return (ARCHIVE_OK);
1443 * The utimes()-family functions provide high resolution and
1444 * a way to set time on an fd or a symlink. We prefer them
1445 * when they're available.
1448 set_time(struct archive_write_disk *a)
1450 struct timeval times[2];
1452 times[1].tv_sec = archive_entry_mtime(a->entry);
1453 times[1].tv_usec = archive_entry_mtime_nsec(a->entry) / 1000;
1455 times[0].tv_sec = archive_entry_atime(a->entry);
1456 times[0].tv_usec = archive_entry_atime_nsec(a->entry) / 1000;
1459 if (a->fd >= 0 && futimes(a->fd, times) == 0) {
1460 return (ARCHIVE_OK);
1465 if (lutimes(a->name, times) != 0)
1467 if (!S_ISLNK(a->mode) && utimes(a->name, times) != 0)
1470 archive_set_error(&a->archive, errno, "Can't update time for %s",
1472 return (ARCHIVE_WARN);
1476 * Note: POSIX does not provide a portable way to restore ctime.
1477 * (Apart from resetting the system clock, which is distasteful.)
1478 * So, any restoration of ctime will necessarily be OS-specific.
1481 /* XXX TODO: Can FreeBSD restore ctime? XXX */
1482 return (ARCHIVE_OK);
1484 #elif defined(HAVE_UTIME)
1486 * utime() is an older, more standard interface that we'll use
1487 * if utimes() isn't available.
1490 set_time(struct archive_write_disk *a)
1492 struct utimbuf times;
1494 times.modtime = archive_entry_mtime(a->entry);
1495 times.actime = archive_entry_atime(a->entry);
1496 if (!S_ISLNK(a->mode) && utime(a->name, ×) != 0) {
1497 archive_set_error(&a->archive, errno,
1498 "Can't update time for %s", a->name);
1499 return (ARCHIVE_WARN);
1501 return (ARCHIVE_OK);
1504 /* This platform doesn't give us a way to restore the time. */
1506 set_time(struct archive_write_disk *a)
1508 (void)a; /* UNUSED */
1509 archive_set_error(&a->archive, errno,
1510 "Can't update time for %s", a->name);
1511 return (ARCHIVE_WARN);
1517 set_mode(struct archive_write_disk *a, int mode)
1520 mode &= 07777; /* Strip off file type bits. */
1522 if (a->todo & TODO_SGID_CHECK) {
1524 * If we don't know the GID is right, we must stat()
1525 * to verify it. We can't just check the GID of this
1526 * process, since systems sometimes set GID from
1527 * the enclosing dir or based on ACLs.
1529 if (a->pst != NULL) {
1530 /* Already have stat() data available. */
1532 } else if (fd >= 0 && fstat(fd, &a->st) == 0) {
1535 } else if (stat(a->name, &a->st) == 0) {
1538 archive_set_error(&a->archive, errno,
1539 "Couldn't stat file");
1540 return (ARCHIVE_WARN);
1542 if (a->pst->st_gid != a->gid) {
1544 if (a->flags & ARCHIVE_EXTRACT_OWNER) {
1546 * This is only an error if you
1547 * requested owner restore. If you
1548 * didn't, we'll try to restore
1549 * sgid/suid, but won't consider it a
1550 * problem if we can't.
1552 archive_set_error(&a->archive, -1,
1553 "Can't restore SGID bit");
1557 /* While we're here, double-check the UID. */
1558 if (a->pst->st_uid != a->uid
1559 && (a->todo & TODO_SUID)) {
1561 if (a->flags & ARCHIVE_EXTRACT_OWNER) {
1562 archive_set_error(&a->archive, -1,
1563 "Can't restore SUID bit");
1567 a->todo &= ~TODO_SGID_CHECK;
1568 a->todo &= ~TODO_SUID_CHECK;
1569 } else if (a->todo & TODO_SUID_CHECK) {
1571 * If we don't know the UID is right, we can just check
1572 * the user, since all systems set the file UID from
1575 if (a->user_uid != a->uid) {
1577 if (a->flags & ARCHIVE_EXTRACT_OWNER) {
1578 archive_set_error(&a->archive, -1,
1579 "Can't make file SUID");
1583 a->todo &= ~TODO_SUID_CHECK;
1586 if (S_ISLNK(a->mode)) {
1589 * If this is a symlink, use lchmod(). If the
1590 * platform doesn't support lchmod(), just skip it. A
1591 * platform that doesn't provide a way to set
1592 * permissions on symlinks probably ignores
1593 * permissions on symlinks, so a failure here has no
1596 if (lchmod(a->name, mode) != 0) {
1597 archive_set_error(&a->archive, errno,
1598 "Can't set permissions to 0%o", (int)mode);
1602 } else if (!S_ISDIR(a->mode)) {
1604 * If it's not a symlink and not a dir, then use
1605 * fchmod() or chmod(), depending on whether we have
1606 * an fd. Dirs get their perms set during the
1607 * post-extract fixup, which is handled elsewhere.
1611 if (fchmod(a->fd, mode) != 0) {
1612 archive_set_error(&a->archive, errno,
1613 "Can't set permissions to 0%o", (int)mode);
1618 /* If this platform lacks fchmod(), then
1619 * we'll just use chmod(). */
1620 if (chmod(a->name, mode) != 0) {
1621 archive_set_error(&a->archive, errno,
1622 "Can't set permissions to 0%o", (int)mode);
1630 set_fflags(struct archive_write_disk *a)
1632 struct fixup_entry *le;
1633 unsigned long set, clear;
1636 mode_t mode = archive_entry_mode(a->entry);
1639 * Make 'critical_flags' hold all file flags that can't be
1640 * immediately restored. For example, on BSD systems,
1641 * SF_IMMUTABLE prevents hardlinks from being created, so
1642 * should not be set until after any hardlinks are created. To
1643 * preserve some semblance of portability, this uses #ifdef
1644 * extensively. Ugly, but it works.
1646 * Yes, Virginia, this does create a security race. It's mitigated
1647 * somewhat by the practice of creating dirs 0700 until the extract
1648 * is done, but it would be nice if we could do more than that.
1649 * People restoring critical file systems should be wary of
1650 * other programs that might try to muck with files as they're
1653 /* Hopefully, the compiler will optimize this mess into a constant. */
1656 critical_flags |= SF_IMMUTABLE;
1659 critical_flags |= UF_IMMUTABLE;
1662 critical_flags |= SF_APPEND;
1665 critical_flags |= UF_APPEND;
1667 #ifdef EXT2_APPEND_FL
1668 critical_flags |= EXT2_APPEND_FL;
1670 #ifdef EXT2_IMMUTABLE_FL
1671 critical_flags |= EXT2_IMMUTABLE_FL;
1674 if (a->todo & TODO_FFLAGS) {
1675 archive_entry_fflags(a->entry, &set, &clear);
1678 * The first test encourages the compiler to eliminate
1679 * all of this if it's not necessary.
1681 if ((critical_flags != 0) && (set & critical_flags)) {
1682 le = current_fixup(a, a->name);
1683 le->fixup |= TODO_FFLAGS;
1684 le->fflags_set = set;
1685 /* Store the mode if it's not already there. */
1686 if ((le->fixup & TODO_MODE) == 0)
1689 r = set_fflags_platform(a, a->fd,
1690 a->name, mode, set, clear);
1691 if (r != ARCHIVE_OK)
1695 return (ARCHIVE_OK);
1699 #if ( defined(HAVE_LCHFLAGS) || defined(HAVE_CHFLAGS) || defined(HAVE_FCHFLAGS) ) && !defined(__linux)
1701 set_fflags_platform(struct archive_write_disk *a, int fd, const char *name,
1702 mode_t mode, unsigned long set, unsigned long clear)
1704 (void)mode; /* UNUSED */
1705 if (set == 0 && clear == 0)
1706 return (ARCHIVE_OK);
1709 * XXX Is the stat here really necessary? Or can I just use
1710 * the 'set' flags directly? In particular, I'm not sure
1711 * about the correct approach if we're overwriting an existing
1712 * file that already has flags on it. XXX
1714 if (fd >= 0 && fstat(fd, &a->st) == 0)
1716 else if (lstat(name, &a->st) == 0)
1719 archive_set_error(&a->archive, errno,
1720 "Couldn't stat file");
1721 return (ARCHIVE_WARN);
1724 a->st.st_flags &= ~clear;
1725 a->st.st_flags |= set;
1726 #ifdef HAVE_FCHFLAGS
1727 /* If platform has fchflags() and we were given an fd, use it. */
1728 if (fd >= 0 && fchflags(fd, a->st.st_flags) == 0)
1729 return (ARCHIVE_OK);
1732 * If we can't use the fd to set the flags, we'll use the
1733 * pathname to set flags. We prefer lchflags() but will use
1734 * chflags() if we must.
1736 #ifdef HAVE_LCHFLAGS
1737 if (lchflags(name, a->st.st_flags) == 0)
1738 return (ARCHIVE_OK);
1739 #elif defined(HAVE_CHFLAGS)
1740 if (S_ISLNK(a->st.st_mode)) {
1741 archive_set_error(&a->archive, errno,
1742 "Can't set file flags on symlink.");
1743 return (ARCHIVE_WARN);
1745 if (chflags(name, a->st.st_flags) == 0)
1746 return (ARCHIVE_OK);
1748 archive_set_error(&a->archive, errno,
1749 "Failed to set file flags");
1750 return (ARCHIVE_WARN);
1753 #elif defined(__linux) && defined(EXT2_IOC_GETFLAGS) && defined(EXT2_IOC_SETFLAGS)
1756 * Linux has flags too, but uses ioctl() to access them instead of
1757 * having a separate chflags() system call.
1760 set_fflags_platform(struct archive_write_disk *a, int fd, const char *name,
1761 mode_t mode, unsigned long set, unsigned long clear)
1765 unsigned long newflags, oldflags;
1766 unsigned long sf_mask = 0;
1768 if (set == 0 && clear == 0)
1769 return (ARCHIVE_OK);
1770 /* Only regular files and dirs can have flags. */
1771 if (!S_ISREG(mode) && !S_ISDIR(mode))
1772 return (ARCHIVE_OK);
1774 /* If we weren't given an fd, open it ourselves. */
1776 myfd = open(name, O_RDONLY|O_NONBLOCK);
1778 return (ARCHIVE_OK);
1781 * Linux has no define for the flags that are only settable by
1782 * the root user. This code may seem a little complex, but
1783 * there seem to be some Linux systems that lack these
1784 * defines. (?) The code below degrades reasonably gracefully
1785 * if sf_mask is incomplete.
1787 #ifdef EXT2_IMMUTABLE_FL
1788 sf_mask |= EXT2_IMMUTABLE_FL;
1790 #ifdef EXT2_APPEND_FL
1791 sf_mask |= EXT2_APPEND_FL;
1794 * XXX As above, this would be way simpler if we didn't have
1795 * to read the current flags from disk. XXX
1798 /* Try setting the flags as given. */
1799 if (ioctl(myfd, EXT2_IOC_GETFLAGS, &oldflags) >= 0) {
1800 newflags = (oldflags & ~clear) | set;
1801 if (ioctl(myfd, EXT2_IOC_SETFLAGS, &newflags) >= 0)
1806 /* If we couldn't set all the flags, try again with a subset. */
1807 if (ioctl(myfd, EXT2_IOC_GETFLAGS, &oldflags) >= 0) {
1808 newflags &= ~sf_mask;
1809 oldflags &= sf_mask;
1810 newflags |= oldflags;
1811 if (ioctl(myfd, EXT2_IOC_SETFLAGS, &newflags) >= 0)
1814 /* We couldn't set the flags, so report the failure. */
1816 archive_set_error(&a->archive, errno,
1817 "Failed to set file flags");
1825 #else /* Not HAVE_CHFLAGS && Not __linux */
1828 * Of course, some systems have neither BSD chflags() nor Linux' flags
1829 * support through ioctl().
1832 set_fflags_platform(struct archive_write_disk *a, int fd, const char *name,
1833 mode_t mode, unsigned long set, unsigned long clear)
1835 (void)a; /* UNUSED */
1836 (void)fd; /* UNUSED */
1837 (void)name; /* UNUSED */
1838 (void)mode; /* UNUSED */
1839 (void)set; /* UNUSED */
1840 (void)clear; /* UNUSED */
1841 return (ARCHIVE_OK);
1844 #endif /* __linux */
1846 #ifndef HAVE_POSIX_ACL
1847 /* Default empty function body to satisfy mainline code. */
1849 set_acls(struct archive_write_disk *a)
1851 (void)a; /* UNUSED */
1852 return (ARCHIVE_OK);
1858 * XXX TODO: What about ACL types other than ACCESS and DEFAULT?
1861 set_acls(struct archive_write_disk *a)
1865 ret = set_acl(a, a->fd, a->entry, ACL_TYPE_ACCESS,
1866 ARCHIVE_ENTRY_ACL_TYPE_ACCESS, "access");
1867 if (ret != ARCHIVE_OK)
1869 ret = set_acl(a, a->fd, a->entry, ACL_TYPE_DEFAULT,
1870 ARCHIVE_ENTRY_ACL_TYPE_DEFAULT, "default");
1876 set_acl(struct archive_write_disk *a, int fd, struct archive_entry *entry,
1877 acl_type_t acl_type, int ae_requested_type, const char *tname)
1880 acl_entry_t acl_entry;
1881 acl_permset_t acl_permset;
1883 int ae_type, ae_permset, ae_tag, ae_id;
1886 const char *ae_name;
1891 entries = archive_entry_acl_reset(entry, ae_requested_type);
1893 return (ARCHIVE_OK);
1894 acl = acl_init(entries);
1895 while (archive_entry_acl_next(entry, ae_requested_type, &ae_type,
1896 &ae_permset, &ae_tag, &ae_id, &ae_name) == ARCHIVE_OK) {
1897 acl_create_entry(&acl, &acl_entry);
1900 case ARCHIVE_ENTRY_ACL_USER:
1901 acl_set_tag_type(acl_entry, ACL_USER);
1902 ae_uid = a->lookup_uid(a->lookup_uid_data,
1904 acl_set_qualifier(acl_entry, &ae_uid);
1906 case ARCHIVE_ENTRY_ACL_GROUP:
1907 acl_set_tag_type(acl_entry, ACL_GROUP);
1908 ae_gid = a->lookup_gid(a->lookup_gid_data,
1910 acl_set_qualifier(acl_entry, &ae_gid);
1912 case ARCHIVE_ENTRY_ACL_USER_OBJ:
1913 acl_set_tag_type(acl_entry, ACL_USER_OBJ);
1915 case ARCHIVE_ENTRY_ACL_GROUP_OBJ:
1916 acl_set_tag_type(acl_entry, ACL_GROUP_OBJ);
1918 case ARCHIVE_ENTRY_ACL_MASK:
1919 acl_set_tag_type(acl_entry, ACL_MASK);
1921 case ARCHIVE_ENTRY_ACL_OTHER:
1922 acl_set_tag_type(acl_entry, ACL_OTHER);
1929 acl_get_permset(acl_entry, &acl_permset);
1930 acl_clear_perms(acl_permset);
1931 if (ae_permset & ARCHIVE_ENTRY_ACL_EXECUTE)
1932 acl_add_perm(acl_permset, ACL_EXECUTE);
1933 if (ae_permset & ARCHIVE_ENTRY_ACL_WRITE)
1934 acl_add_perm(acl_permset, ACL_WRITE);
1935 if (ae_permset & ARCHIVE_ENTRY_ACL_READ)
1936 acl_add_perm(acl_permset, ACL_READ);
1939 name = archive_entry_pathname(entry);
1941 /* Try restoring the ACL through 'fd' if we can. */
1943 if (fd >= 0 && acl_type == ACL_TYPE_ACCESS && acl_set_fd(fd, acl) == 0)
1947 #if HAVE_ACL_SET_FD_NP
1948 if (fd >= 0 && acl_set_fd_np(fd, acl, acl_type) == 0)
1953 if (acl_set_file(name, acl_type, acl) != 0) {
1954 archive_set_error(&a->archive, errno, "Failed to set %s acl", tname);
1964 * Restore extended attributes - Linux implementation
1967 set_xattrs(struct archive_write_disk *a)
1969 struct archive_entry *entry = a->entry;
1970 static int warning_done = 0;
1971 int ret = ARCHIVE_OK;
1972 int i = archive_entry_xattr_reset(entry);
1978 archive_entry_xattr_next(entry, &name, &value, &size);
1980 strncmp(name, "xfsroot.", 8) != 0 &&
1981 strncmp(name, "system.", 7) != 0) {
1985 e = fsetxattr(a->fd, name, value, size, 0);
1989 e = lsetxattr(archive_entry_pathname(entry),
1990 name, value, size, 0);
1993 if (errno == ENOTSUP) {
1994 if (!warning_done) {
1996 archive_set_error(&a->archive, errno,
1997 "Cannot restore extended "
1998 "attributes on this file "
2002 archive_set_error(&a->archive, errno,
2003 "Failed to set extended attribute");
2007 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2008 "Invalid extended attribute encountered");
2016 * Restore extended attributes - stub implementation for unsupported systems
2019 set_xattrs(struct archive_write_disk *a)
2021 static int warning_done = 0;
2023 /* If there aren't any extended attributes, then it's okay not
2024 * to extract them, otherwise, issue a single warning. */
2025 if (archive_entry_xattr_count(a->entry) != 0 && !warning_done) {
2027 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2028 "Cannot restore extended attributes on this system");
2029 return (ARCHIVE_WARN);
2031 /* Warning was already emitted; suppress further warnings. */
2032 return (ARCHIVE_OK);
2038 * Trivial implementations of gid/uid lookup functions.
2039 * These are normally overridden by the client, but these stub
2040 * versions ensure that we always have something that works.
2043 trivial_lookup_gid(void *private_data, const char *gname, gid_t gid)
2045 (void)private_data; /* UNUSED */
2046 (void)gname; /* UNUSED */
2051 trivial_lookup_uid(void *private_data, const char *uname, uid_t uid)
2053 (void)private_data; /* UNUSED */
2054 (void)uname; /* UNUSED */
2059 * Test if file on disk is older than entry.
2062 older(struct stat *st, struct archive_entry *entry)
2064 /* First, test the seconds and return if we have a definite answer. */
2065 /* Definitely older. */
2066 if (st->st_mtime < archive_entry_mtime(entry))
2068 /* Definitely younger. */
2069 if (st->st_mtime > archive_entry_mtime(entry))
2071 /* If this platform supports fractional seconds, try those. */
2072 #if HAVE_STRUCT_STAT_ST_MTIMESPEC_TV_NSEC
2073 /* Definitely older. */
2074 if (st->st_mtimespec.tv_nsec < archive_entry_mtime_nsec(entry))
2076 /* Definitely younger. */
2077 if (st->st_mtimespec.tv_nsec > archive_entry_mtime_nsec(entry))
2079 #elif HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
2080 /* Definitely older. */
2081 if (st->st_mtim.tv_nsec < archive_entry_mtime_nsec(entry))
2083 /* Definitely older. */
2084 if (st->st_mtim.tv_nsec > archive_entry_mtime_nsec(entry))
2087 /* This system doesn't have high-res timestamps. */
2089 /* Same age, so not older. */