Skip to content

Commit

Permalink
Improve extended attribute support
Browse files Browse the repository at this point in the history
Mac OS X changes:
  - add support for extended file attributes via sys/xattr.h
  - when extracting an archive entry that has mac_metadata and
    mac_metadata is requested to be extracted, extended attributes
    are restored only from mac_metadata.
  - by default, extended attributes are stored both in mac_metadata and
    SCHILY.xattr/LIBARCHIVE.xattr. This is subject to review and change.

To match behavior on other platforms, store extended attributes on
FreeBSD with extattr_set_link() if no fd is provided.

Detection of extended attributes support in configure stage has been
rewritten.

Added xattr platform test to libarchive and xattrs option test to bsdtar.
  • Loading branch information
mmatuska committed Mar 23, 2017
1 parent 3627d67 commit 365a91d
Show file tree
Hide file tree
Showing 15 changed files with 668 additions and 132 deletions.
144 changes: 96 additions & 48 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,7 @@ LA_CHECK_INCLUDE_FILE("sys/types.h" HAVE_SYS_TYPES_H)

# Alphabetize the rest unless there's a compelling reason
LA_CHECK_INCLUDE_FILE("acl/libacl.h" HAVE_ACL_LIBACL_H)
LA_CHECK_INCLUDE_FILE("attr/xattr.h" HAVE_ATTR_XATTR_H)
LA_CHECK_INCLUDE_FILE("ctype.h" HAVE_CTYPE_H)
LA_CHECK_INCLUDE_FILE("copyfile.h" HAVE_COPYFILE_H)
LA_CHECK_INCLUDE_FILE("direct.h" HAVE_DIRECT_H)
Expand Down Expand Up @@ -597,6 +598,7 @@ LA_CHECK_INCLUDE_FILE("string.h" HAVE_STRING_H)
LA_CHECK_INCLUDE_FILE("strings.h" HAVE_STRINGS_H)
LA_CHECK_INCLUDE_FILE("sys/acl.h" HAVE_SYS_ACL_H)
LA_CHECK_INCLUDE_FILE("sys/cdefs.h" HAVE_SYS_CDEFS_H)
LA_CHECK_INCLUDE_FILE("sys/extattr.h" HAVE_SYS_EXTATTR_H)
LA_CHECK_INCLUDE_FILE("sys/ioctl.h" HAVE_SYS_IOCTL_H)
LA_CHECK_INCLUDE_FILE("sys/mkdev.h" HAVE_SYS_MKDEV_H)
LA_CHECK_INCLUDE_FILE("sys/mount.h" HAVE_SYS_MOUNT_H)
Expand All @@ -612,6 +614,7 @@ LA_CHECK_INCLUDE_FILE("sys/utime.h" HAVE_SYS_UTIME_H)
LA_CHECK_INCLUDE_FILE("sys/utsname.h" HAVE_SYS_UTSNAME_H)
LA_CHECK_INCLUDE_FILE("sys/vfs.h" HAVE_SYS_VFS_H)
LA_CHECK_INCLUDE_FILE("sys/wait.h" HAVE_SYS_WAIT_H)
LA_CHECK_INCLUDE_FILE("sys/xattr.h" HAVE_SYS_XATTR_H)
LA_CHECK_INCLUDE_FILE("time.h" HAVE_TIME_H)
LA_CHECK_INCLUDE_FILE("unistd.h" HAVE_UNISTD_H)
LA_CHECK_INCLUDE_FILE("utime.h" HAVE_UTIME_H)
Expand Down Expand Up @@ -1532,60 +1535,105 @@ CHECK_FILE_OFFSET_BITS()
# Check for Extended Attribute libraries, headers, and functions
#
IF(ENABLE_XATTR)
LA_CHECK_INCLUDE_FILE(attr/xattr.h HAVE_ATTR_XATTR_H)
LA_CHECK_INCLUDE_FILE(sys/xattr.h HAVE_SYS_XATTR_H)
LA_CHECK_INCLUDE_FILE(sys/extattr.h HAVE_SYS_EXTATTR_H)
CHECK_LIBRARY_EXISTS(attr "setxattr" "" HAVE_LIBATTR)
IF(HAVE_LIBATTR)
SET(CMAKE_REQUIRED_LIBRARIES "attr")
ENDIF(HAVE_LIBATTR)
CHECK_SYMBOL_EXISTS(EXTATTR_NAMESPACE_USER "sys/types.h;sys/extattr.h" HAVE_DECL_EXTATTR_NAMESPACE_USER)
CHECK_FUNCTION_EXISTS_GLIBC(extattr_get_file HAVE_EXTATTR_GET_FILE)
CHECK_FUNCTION_EXISTS_GLIBC(extattr_list_file HAVE_EXTATTR_LIST_FILE)
CHECK_FUNCTION_EXISTS_GLIBC(extattr_set_fd HAVE_EXTATTR_SET_FD)
CHECK_FUNCTION_EXISTS_GLIBC(extattr_set_file HAVE_EXTATTR_SET_FILE)
CHECK_FUNCTION_EXISTS_GLIBC(fgetxattr HAVE_FGETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(flistxattr HAVE_FLISTXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(fsetxattr HAVE_FSETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(getxattr HAVE_GETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(lgetxattr HAVE_LGETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(listxattr HAVE_LISTXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(llistxattr HAVE_LLISTXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(lsetxattr HAVE_LSETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(fgetea HAVE_FGETEA)
CHECK_FUNCTION_EXISTS_GLIBC(flistea HAVE_FLISTEA)
CHECK_FUNCTION_EXISTS_GLIBC(fsetea HAVE_FSETEA)
CHECK_FUNCTION_EXISTS_GLIBC(getea HAVE_GETEA)
CHECK_FUNCTION_EXISTS_GLIBC(lgetea HAVE_LGETEA)
CHECK_FUNCTION_EXISTS_GLIBC(listea HAVE_LISTEA)
CHECK_FUNCTION_EXISTS_GLIBC(llistea HAVE_LLISTEA)
CHECK_FUNCTION_EXISTS_GLIBC(lsetea HAVE_LSETEA)
CHECK_SYMBOL_EXISTS(XATTR_NOFOLLOW "sys/xattr.h" HAVE_DECL_XATTR_NOFOLLOW)
IF(HAVE_SYS_XATTR_H AND HAVE_DECL_XATTR_NOFOLLOW)
CHECK_FUNCTION_EXISTS(fgetxattr HAVE_FGETXATTR)
CHECK_FUNCTION_EXISTS(flistxattr HAVE_FLISTXATTR)
CHECK_FUNCTION_EXISTS(fsetxattr HAVE_FSETXATTR)
CHECK_FUNCTION_EXISTS(getxattr HAVE_GETXATTR)
CHECK_FUNCTION_EXISTS(listxattr HAVE_LISTXATTR)
CHECK_FUNCTION_EXISTS(setxattr HAVE_SETXATTR)
IF(HAVE_FGETXATTR AND
HAVE_FLISTXATTR AND
HAVE_FSETXATTR AND
HAVE_GETXATTR AND
HAVE_LISTXATTR AND
HAVE_SETXATTR)
SET(ARCHIVE_XATTR_DARWIN TRUE)
ENDIF()
ELSEIF(HAVE_SYS_EXTATTR_H AND HAVE_DECL_EXTATTR_NAMESPACE_USER)
# FreeBSD xattr support
CHECK_FUNCTION_EXISTS(extattr_get_fd HAVE_EXTATTR_GET_FD)
CHECK_FUNCTION_EXISTS(extattr_get_file HAVE_EXTATTR_GET_FILE)
CHECK_FUNCTION_EXISTS(extattr_get_link HAVE_EXTATTR_GET_LINK)
CHECK_FUNCTION_EXISTS(extattr_list_fd HAVE_EXTATTR_LIST_FD)
CHECK_FUNCTION_EXISTS(extattr_list_file HAVE_EXTATTR_LIST_FILE)
CHECK_FUNCTION_EXISTS(extattr_list_link HAVE_EXTATTR_LIST_LINK)
CHECK_FUNCTION_EXISTS(extattr_set_fd HAVE_EXTATTR_SET_FD)
CHECK_FUNCTION_EXISTS(extattr_set_link HAVE_EXTATTR_SET_LINK)
IF(HAVE_EXTATTR_GET_FD AND
HAVE_EXTATTR_GET_FILE AND
HAVE_EXTATTR_GET_LINK AND
HAVE_EXTATTR_LIST_FD AND
HAVE_EXTATTR_LIST_FILE AND
HAVE_EXTATTR_LIST_LINK AND
HAVE_EXTATTR_SET_FD AND
HAVE_EXTATTR_SET_LINK)
SET(ARCHIVE_XATTR_FREEBSD TRUE)
ENDIF()
ELSEIF(HAVE_SYS_XATTR_H OR HAVE_ATTR_XATTR_H)
# Linux xattr support
CHECK_FUNCTION_EXISTS_GLIBC(fgetxattr HAVE_FGETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(flistxattr HAVE_FLISTXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(fsetxattr HAVE_FSETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(getxattr HAVE_GETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(lgetxattr HAVE_LGETXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(listxattr HAVE_LISTXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(llistxattr HAVE_LLISTXATTR)
CHECK_FUNCTION_EXISTS_GLIBC(lsetxattr HAVE_LSETXATTR)
IF(HAVE_FGETXATTR AND
HAVE_FLISTXATTR AND
HAVE_FSETXATTR AND
HAVE_GETXATTR AND
HAVE_LGETXATTR AND
HAVE_LISTXATTR AND
HAVE_LLISTXATTR AND
HAVE_LSETXATTR)
SET(ARCHIVE_XATTR_LINUX TRUE)
ENDIF()
ELSEIF(HAVE_SYS_EA_H)
# AIX xattr support
CHECK_FUNCTION_EXISTS(fgetea HAVE_FGETEA)
CHECK_FUNCTION_EXISTS(flistea HAVE_FLISTEA)
CHECK_FUNCTION_EXISTS(fsetea HAVE_FSETEA)
CHECK_FUNCTION_EXISTS(getea HAVE_GETEA)
CHECK_FUNCTION_EXISTS(lgetea HAVE_LGETEA)
CHECK_FUNCTION_EXISTS(listea HAVE_LISTEA)
CHECK_FUNCTION_EXISTS(llistea HAVE_LLISTEA)
CHECK_FUNCTION_EXISTS(lsetea HAVE_LSETEA)
IF(HAVE_FGETEA AND
HAVE_FLISTEA AND
HAVE_FSETEA AND
HAVE_GETEA AND
HAVE_LGETEA AND
HAVE_LISTEA AND
HAVE_LLISTEA AND
HAVE_LSETEA)
SET(ARCHIVE_XATTR_AIX TRUE)
ENDIF()
ENDIF()

IF(ARCHIVE_XATTR_DARWIN)
MESSAGE(STATUS "Extended attributes support: Darwin")
ELSEIF(ARCHIVE_XATTR_FREEBSD)
MESSAGE(STATUS "Extended attributes support: FreeBSD")
ELSEIF(ARCHIVE_XATTR_LINUX)
MESSAGE(STATUS "Extended attributes support: Linux")
ELSEIF(ARCHIVE_XATTR_AIX)
MESSAGE(STATUS "Extended attributes support: AIX")
ELSE()
MESSAGE(STATUS "Extended attributes support: none")
ENDIF()
ELSE(ENABLE_XATTR)
SET(HAVE_ATTR_LIB FALSE)
SET(HAVE_ATTR_XATTR_H FALSE)
SET(HAVE_DECL_EXTATTR_NAMESPACE_USER FALSE)
SET(HAVE_EXTATTR_GET_FILE FALSE)
SET(HAVE_EXTATTR_LIST_FILE FALSE)
SET(HAVE_EXTATTR_SET_FD FALSE)
SET(HAVE_EXTATTR_SET_FILE FALSE)
SET(HAVE_FGETEA FALSE)
SET(HAVE_FGETXATTR FALSE)
SET(HAVE_FLISTEA FALSE)
SET(HAVE_FLISTXATTR FALSE)
SET(HAVE_FSETEA FALSE)
SET(HAVE_FSETXATTR FALSE)
SET(HAVE_GETEA FALSE)
SET(HAVE_GETXATTR FALSE)
SET(HAVE_LGETEA FALSE)
SET(HAVE_LGETXATTR FALSE)
SET(HAVE_LISTEA FALSE)
SET(HAVE_LISTXATTR FALSE)
SET(HAVE_LLISTEA FALSE)
SET(HAVE_LLISTXATTR FALSE)
SET(HAVE_LSETEA FALSE)
SET(HAVE_LSETXATTR FALSE)
SET(HAVE_SYS_EXTATTR_H FALSE)
SET(HAVE_SYS_XATTR_H FALSE)
SET(ARCHIVE_XATTR_DARWIN FALSE)
SET(ARCHIVE_XATTR_FREEBSD FALSE)
SET(ARCHIVE_XATTR_LINUX FALSE)
SET(ARCHIVE_XATTR_AIX FALSE)
ENDIF(ENABLE_XATTR)

#
Expand Down
3 changes: 3 additions & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ libarchive_la_SOURCES= \
libarchive/archive_pathmatch.h \
libarchive/archive_platform.h \
libarchive/archive_platform_acl.h \
libarchive/archive_platform_xattr.h \
libarchive/archive_ppmd_private.h \
libarchive/archive_ppmd7.c \
libarchive/archive_ppmd7_private.h \
Expand Down Expand Up @@ -618,6 +619,7 @@ libarchive_test_SOURCES= \
libarchive/test/test_write_format_zip_zip64.c \
libarchive/test/test_write_open_memory.c \
libarchive/test/test_write_read_format_zip.c \
libarchive/test/test_xattr_platform.c \
libarchive/test/test_zip_filename_encoding.c

libarchive_test_CPPFLAGS= \
Expand Down Expand Up @@ -1009,6 +1011,7 @@ bsdtar_test_SOURCES= \
tar/test/test_option_s.c \
tar/test/test_option_uid_uname.c \
tar/test/test_option_uuencode.c \
tar/test/test_option_xattrs.c \
tar/test/test_option_xz.c \
tar/test/test_option_z.c \
tar/test/test_patterns.c \
Expand Down
16 changes: 16 additions & 0 deletions build/cmake/config.h.in
Original file line number Diff line number Diff line change
Expand Up @@ -302,6 +302,18 @@ typedef uint64_t uintmax_t;
/* SHA512 via ARCHIVE_CRYPTO_SHA512_WIN supported. */
#cmakedefine ARCHIVE_CRYPTO_SHA512_WIN 1

/* AIX xattr support */
#cmakedefine ARCHIVE_XATTR_AIX 1

/* Darwin xattr support */
#cmakedefine ARCHIVE_XATTR_DARWIN 1

/* FreeBSD xattr support */
#cmakedefine ARCHIVE_XATTR_FREEBSD 1

/* Linux xattr support */
#cmakedefine ARCHIVE_XATTR_LINUX 1

/* Version number of bsdcpio */
#cmakedefine BSDCPIO_VERSION_STRING "${BSDCPIO_VERSION_STRING}"

Expand Down Expand Up @@ -463,6 +475,10 @@ typedef uint64_t uintmax_t;
don't. */
#cmakedefine HAVE_DECL_UINTMAX_MAX 1

/* Define to 1 if you have the declaration of `XATTR_NOFOLLOW', and to 0 if
you don't. */
#cmakedefine HAVE_DECL_XATTR_NOFOLLOW 1

/* Define to 1 if you have the <direct.h> header file. */
#cmakedefine HAVE_DIRECT_H 1

Expand Down
116 changes: 103 additions & 13 deletions configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ esac
# Checks for header files.
AC_HEADER_DIRENT
AC_HEADER_SYS_WAIT
AC_CHECK_HEADERS([acl/libacl.h])
AC_CHECK_HEADERS([acl/libacl.h attr/xattr.h])
AC_CHECK_HEADERS([copyfile.h ctype.h])
AC_CHECK_HEADERS([errno.h ext2fs/ext2_fs.h fcntl.h grp.h])

Expand Down Expand Up @@ -287,11 +287,11 @@ AS_VAR_IF([ac_cv_have_decl_FS_IOC_GETFLAGS], [yes],
AC_CHECK_HEADERS([locale.h membership.h paths.h poll.h pthread.h pwd.h])
AC_CHECK_HEADERS([readpassphrase.h signal.h spawn.h])
AC_CHECK_HEADERS([stdarg.h stdint.h stdlib.h string.h])
AC_CHECK_HEADERS([sys/acl.h sys/cdefs.h sys/extattr.h])
AC_CHECK_HEADERS([sys/acl.h sys/cdefs.h sys/ea.h sys/extattr.h])
AC_CHECK_HEADERS([sys/ioctl.h sys/mkdev.h sys/mount.h])
AC_CHECK_HEADERS([sys/param.h sys/poll.h sys/richacl.h])
AC_CHECK_HEADERS([sys/select.h sys/statfs.h sys/statvfs.h])
AC_CHECK_HEADERS([sys/time.h sys/utime.h sys/utsname.h sys/vfs.h])
AC_CHECK_HEADERS([sys/time.h sys/utime.h sys/utsname.h sys/vfs.h sys/xattr.h])
AC_CHECK_HEADERS([time.h unistd.h utime.h wchar.h wctype.h])
AC_CHECK_HEADERS([windows.h])
# check windows.h first; the other headers require it.
Expand Down Expand Up @@ -675,18 +675,108 @@ AC_ARG_ENABLE([xattr],
[Disable Extended Attributes support (default: check)]))

if test "x$enable_xattr" != "xno"; then
AC_CHECK_HEADERS([attr/xattr.h])
AC_CHECK_HEADERS([sys/xattr.h sys/ea.h])
AC_SEARCH_LIBS([setxattr], [attr])
AC_CHECK_FUNCS([extattr_get_file extattr_list_file])
AC_CHECK_FUNCS([extattr_set_fd extattr_set_file])
AC_CHECK_FUNCS([fgetxattr flistxattr fsetxattr getxattr])
AC_CHECK_FUNCS([lgetxattr listxattr llistxattr lsetxattr])
AC_CHECK_FUNCS([fgetea flistea fsetea getea])
AC_CHECK_FUNCS([lgetea listea llistea lsetea])
AC_CHECK_DECLS([EXTATTR_NAMESPACE_USER], [], [], [#include <sys/types.h>
AC_SEARCH_LIBS([setxattr], [attr])
AC_CHECK_DECLS([EXTATTR_NAMESPACE_USER], [], [], [#include <sys/types.h>
#include <sys/extattr.h>
])
AC_CHECK_DECLS([XATTR_NOFOLLOW], [], [], [#include <sys/xattr.h>
])
if test "x$ac_cv_header_sys_xattr_h" = "xyes" \
-a "x$ac_cv_have_decl_XATTR_NOFOLLOW" = "xyes"; then
# Darwin extended attributes support
AC_CACHE_VAL([ac_cv_archive_xattr_darwin],
[AC_CHECK_FUNCS(fgetxattr \
flistxattr \
fsetxattr \
getxattr \
listxattr \
setxattr,
[ac_cv_archive_xattr_darwin=yes],
[ac_cv_archive_xattr_darwin=no],
[#include <sys/xattr.h>
])
]
)
elif test "x$ac_cv_header_sys_extattr_h" = "xyes" \
-a "x$ac_cv_have_decl_EXTATTR_NAMESPACE_USER" = "xyes"; then
# FreeBSD extended attributes support
AC_CACHE_VAL([ac_cv_archive_xattr_freebsd],
[AC_CHECK_FUNCS(extattr_get_fd \
extattr_get_file \
extattr_get_link \
extattr_list_fd \
extattr_list_file \
extattr_list_link \
extattr_set_fd \
extattr_set_link,
[ac_cv_archive_xattr_freebsd=yes],
[ac_cv_archive_xattr_freebsd=no],
[#include <sys/types.h>
#include <sys/extattr.h>
])
]
)
elif test "x$ac_cv_header_sys_xattr_h" = "xyes" \
-o "x$ac_cv_header_attr_xattr_h" = "xyes"; then
# Linux extended attributes support
AC_CACHE_VAL([ac_cv_archive_xattr_linux],
[AC_CHECK_FUNCS(fgetxattr \
flistxattr \
fsetxattr \
getxattr \
lgetxattr \
listxattr \
llistxattr \
lsetxattr,
[ac_cv_archive_xattr_linux=yes],
[ac_cv_archive_xattr_linux=no],
[#if HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#if HAVE_SYS_XATTR_H
#include <sys/xattr.h>
#endif
#if HAVE_ATTR_XATTR_H
#include <attr/xatr.h>
#endif
])
]
)
elif test "x$ac_cv_header_sys_ea_h" = "xyes"; then
# AIX extended attributes support
AC_CACHE_VAL([ac_cv_archive_xattr_aix],
[AC_CHECK_FUNCS(fgetea \
flistea \
fsetea \
getea \
lgetea \
listea \
llistea \
lsetea,
[ac_cv_archive_xattr_aix=yes],
[ac_cv_archive_xattr_aix=no],
[#include <sys/ea.h>
])
]
)
fi

AC_MSG_CHECKING([for extended attributes support])
if test "x$ac_cv_archive_xattr_linux" = "xyes"; then
AC_DEFINE([ARCHIVE_XATTR_LINUX], [1], [Linux xattr support])
AC_MSG_RESULT([Linux])
elif test "x$ac_cv_archive_xattr_darwin" = "xyes"; then
AC_DEFINE([ARCHIVE_XATTR_DARWIN], [1], [Darwin xattr support])
AC_MSG_RESULT([Darwin])
elif test "x$ac_cv_archive_xattr_freebsd" = "xyes"; then
AC_DEFINE([ARCHIVE_XATTR_FREEBSD], [1], [FreeBSD xattr support])
AC_MSG_RESULT([FreeBSD])
elif test "x$ac_cv_archive_xattr_aix" = "xyes"; then
AC_DEFINE([ARCHIVE_XATTR_AIX], [1], [AIX xattr support])
AC_MSG_RESULT([AIX])
else
AC_MSG_RESULT([none])
fi
fi

# Check for ACL support
Expand Down
1 change: 1 addition & 0 deletions libarchive/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ SET(libarchive_SOURCES
archive_pathmatch.h
archive_platform.h
archive_platform_acl.h
archive_platform_xattr.h
archive_ppmd_private.h
archive_ppmd7.c
archive_ppmd7_private.h
Expand Down
Loading

0 comments on commit 365a91d

Please sign in to comment.