contrib/libarchive/libarchive/archive_entry.h

   1 /*-
   2  * Copyright (c) 2003-2008 Tim Kientzle
   3  * Copyright (c) 2016 Martin Matuska
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef ARCHIVE_ENTRY_H_INCLUDED
  30 #define ARCHIVE_ENTRY_H_INCLUDED
  31
  32 /* Note: Compiler will complain if this does not match archive.h! */
  33 #define ARCHIVE_VERSION_NUMBER 3003001
  34
  35 /*
  36  * Note: archive_entry.h is for use outside of libarchive; the
  37  * configuration headers (config.h, archive_platform.h, etc.) are
  38  * purely internal.  Do NOT use HAVE_XXX configuration macros to
  39  * control the behavior of this header!  If you must conditionalize,
  40  * use predefined compiler and/or platform macros.
  41  */
  42
  43 #include <sys/types.h>
  44 #include <stddef.h>  /* for wchar_t */
  45 #include <time.h>
  46
  47 #if defined(_WIN32) && !defined(__CYGWIN__)
  48 #include <windows.h>
  49 #endif
  50
  51 /* Get a suitable 64-bit integer type. */
  52 #if !defined(__LA_INT64_T_DEFINED)
  53 # if ARCHIVE_VERSION_NUMBER < 4000000
  54 #define __LA_INT64_T la_int64_t
  55 # endif
  56 #define __LA_INT64_T_DEFINED
  57 # if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__)
  58 typedef __int64 la_int64_t;
  59 # else
  60 #include <unistd.h>
  61 #  if defined(_SCO_DS) || defined(__osf__)
  62 typedef long long la_int64_t;
  63 #  else
  64 typedef int64_t la_int64_t;
  65 #  endif
  66 # endif
  67 #endif
  68
  69 /* The la_ssize_t should match the type used in 'struct stat' */
  70 #if !defined(__LA_SSIZE_T_DEFINED)
  71 /* Older code relied on the __LA_SSIZE_T macro; after 4.0 we'll switch to the typedef exclusively. */
  72 # if ARCHIVE_VERSION_NUMBER < 4000000
  73 #define __LA_SSIZE_T la_ssize_t
  74 # endif
  75 #define __LA_SSIZE_T_DEFINED
  76 # if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__WATCOMC__)
  77 #  if defined(_SSIZE_T_DEFINED) || defined(_SSIZE_T_)
  78 typedef ssize_t la_ssize_t;
  79 #  elif defined(_WIN64)
  80 typedef __int64 la_ssize_t;
  81 #  else
  82 typedef long la_ssize_t;
  83 #  endif
  84 # else
  85 # include <unistd.h>  /* ssize_t */
  86 typedef ssize_t la_ssize_t;
  87 # endif
  88 #endif
  89
  90 /* Get a suitable definition for mode_t */
  91 #if ARCHIVE_VERSION_NUMBER >= 3999000
  92 /* Switch to plain 'int' for libarchive 4.0.  It's less broken than 'mode_t' */
  93 # define        __LA_MODE_T     int
  94 #elif defined(_WIN32) && !defined(__CYGWIN__) && !defined(__BORLANDC__) && !defined(__WATCOMC__)
  95 # define        __LA_MODE_T     unsigned short
  96 #else
  97 # define        __LA_MODE_T     mode_t
  98 #endif
  99
 100 /* Large file support for Android */
 101 #ifdef __ANDROID__
 102 #include "android_lf.h"
 103 #endif
 104
 105 /*
 106  * On Windows, define LIBARCHIVE_STATIC if you're building or using a
 107  * .lib.  The default here assumes you're building a DLL.  Only
 108  * libarchive source should ever define __LIBARCHIVE_BUILD.
 109  */
 110 #if ((defined __WIN32__) || (defined _WIN32) || defined(__CYGWIN__)) && (!defined LIBARCHIVE_STATIC)
 111 # ifdef __LIBARCHIVE_BUILD
 112 #  ifdef __GNUC__
 113 #   define __LA_DECL    __attribute__((dllexport)) extern
 114 #  else
 115 #   define __LA_DECL    __declspec(dllexport)
 116 #  endif
 117 # else
 118 #  ifdef __GNUC__
 119 #   define __LA_DECL
 120 #  else
 121 #   define __LA_DECL    __declspec(dllimport)
 122 #  endif
 123 # endif
 124 #else
 125 /* Static libraries on all platforms and shared libraries on non-Windows. */
 126 # define __LA_DECL
 127 #endif
 128
 129 #if defined(__GNUC__) && __GNUC__ >= 3 && __GNUC_MINOR__ >= 1
 130 # define __LA_DEPRECATED __attribute__((deprecated))
 131 #else
 132 # define __LA_DEPRECATED
 133 #endif
 134
 135 #ifdef __cplusplus
 136 extern "C" {
 137 #endif
 138
 139 /*
 140  * Description of an archive entry.
 141  *
 142  * You can think of this as "struct stat" with some text fields added in.
 143  *
 144  * TODO: Add "comment", "charset", and possibly other entries that are
 145  * supported by "pax interchange" format.  However, GNU, ustar, cpio,
 146  * and other variants don't support these features, so they're not an
 147  * excruciatingly high priority right now.
 148  *
 149  * TODO: "pax interchange" format allows essentially arbitrary
 150  * key/value attributes to be attached to any entry.  Supporting
 151  * such extensions may make this library useful for special
 152  * applications (e.g., a package manager could attach special
 153  * package-management attributes to each entry).
 154  */
 155 struct archive;
 156 struct archive_entry;
 157
 158 /*
 159  * File-type constants.  These are returned from archive_entry_filetype()
 160  * and passed to archive_entry_set_filetype().
 161  *
 162  * These values match S_XXX defines on every platform I've checked,
 163  * including Windows, AIX, Linux, Solaris, and BSD.  They're
 164  * (re)defined here because platforms generally don't define the ones
 165  * they don't support.  For example, Windows doesn't define S_IFLNK or
 166  * S_IFBLK.  Instead of having a mass of conditional logic and system
 167  * checks to define any S_XXX values that aren't supported locally,
 168  * I've just defined a new set of such constants so that
 169  * libarchive-based applications can manipulate and identify archive
 170  * entries properly even if the hosting platform can't store them on
 171  * disk.
 172  *
 173  * These values are also used directly within some portable formats,
 174  * such as cpio.  If you find a platform that varies from these, the
 175  * correct solution is to leave these alone and translate from these
 176  * portable values to platform-native values when entries are read from
 177  * or written to disk.
 178  */
 179 /*
 180  * In libarchive 4.0, we can drop the casts here.
 181  * They're needed to work around Borland C's broken mode_t.
 182  */
 183 #define AE_IFMT         ((__LA_MODE_T)0170000)
 184 #define AE_IFREG        ((__LA_MODE_T)0100000)
 185 #define AE_IFLNK        ((__LA_MODE_T)0120000)
 186 #define AE_IFSOCK       ((__LA_MODE_T)0140000)
 187 #define AE_IFCHR        ((__LA_MODE_T)0020000)
 188 #define AE_IFBLK        ((__LA_MODE_T)0060000)
 189 #define AE_IFDIR        ((__LA_MODE_T)0040000)
 190 #define AE_IFIFO        ((__LA_MODE_T)0010000)
 191
 192 /*
 193  * Basic object manipulation
 194  */
 195
 196 __LA_DECL struct archive_entry  *archive_entry_clear(struct archive_entry *);
 197 /* The 'clone' function does a deep copy; all of the strings are copied too. */
 198 __LA_DECL struct archive_entry  *archive_entry_clone(struct archive_entry *);
 199 __LA_DECL void                   archive_entry_free(struct archive_entry *);
 200 __LA_DECL struct archive_entry  *archive_entry_new(void);
 201
 202 /*
 203  * This form of archive_entry_new2() will pull character-set
 204  * conversion information from the specified archive handle.  The
 205  * older archive_entry_new(void) form is equivalent to calling
 206  * archive_entry_new2(NULL) and will result in the use of an internal
 207  * default character-set conversion.
 208  */
 209 __LA_DECL struct archive_entry  *archive_entry_new2(struct archive *);
 210
 211 /*
 212  * Retrieve fields from an archive_entry.
 213  *
 214  * There are a number of implicit conversions among these fields.  For
 215  * example, if a regular string field is set and you read the _w wide
 216  * character field, the entry will implicitly convert narrow-to-wide
 217  * using the current locale.  Similarly, dev values are automatically
 218  * updated when you write devmajor or devminor and vice versa.
 219  *
 220  * In addition, fields can be "set" or "unset."  Unset string fields
 221  * return NULL, non-string fields have _is_set() functions to test
 222  * whether they've been set.  You can "unset" a string field by
 223  * assigning NULL; non-string fields have _unset() functions to
 224  * unset them.
 225  *
 226  * Note: There is one ambiguity in the above; string fields will
 227  * also return NULL when implicit character set conversions fail.
 228  * This is usually what you want.
 229  */
 230 __LA_DECL time_t         archive_entry_atime(struct archive_entry *);
 231 __LA_DECL long           archive_entry_atime_nsec(struct archive_entry *);
 232 __LA_DECL int            archive_entry_atime_is_set(struct archive_entry *);
 233 __LA_DECL time_t         archive_entry_birthtime(struct archive_entry *);
 234 __LA_DECL long           archive_entry_birthtime_nsec(struct archive_entry *);
 235 __LA_DECL int            archive_entry_birthtime_is_set(struct archive_entry *);
 236 __LA_DECL time_t         archive_entry_ctime(struct archive_entry *);
 237 __LA_DECL long           archive_entry_ctime_nsec(struct archive_entry *);
 238 __LA_DECL int            archive_entry_ctime_is_set(struct archive_entry *);
 239 __LA_DECL dev_t          archive_entry_dev(struct archive_entry *);
 240 __LA_DECL int            archive_entry_dev_is_set(struct archive_entry *);
 241 __LA_DECL dev_t          archive_entry_devmajor(struct archive_entry *);
 242 __LA_DECL dev_t          archive_entry_devminor(struct archive_entry *);
 243 __LA_DECL __LA_MODE_T    archive_entry_filetype(struct archive_entry *);
 244 __LA_DECL void           archive_entry_fflags(struct archive_entry *,
 245                             unsigned long * /* set */,
 246                             unsigned long * /* clear */);
 247 __LA_DECL const char    *archive_entry_fflags_text(struct archive_entry *);
 248 __LA_DECL la_int64_t     archive_entry_gid(struct archive_entry *);
 249 __LA_DECL const char    *archive_entry_gname(struct archive_entry *);
 250 __LA_DECL const char    *archive_entry_gname_utf8(struct archive_entry *);
 251 __LA_DECL const wchar_t *archive_entry_gname_w(struct archive_entry *);
 252 __LA_DECL const char    *archive_entry_hardlink(struct archive_entry *);
 253 __LA_DECL const char    *archive_entry_hardlink_utf8(struct archive_entry *);
 254 __LA_DECL const wchar_t *archive_entry_hardlink_w(struct archive_entry *);
 255 __LA_DECL la_int64_t     archive_entry_ino(struct archive_entry *);
 256 __LA_DECL la_int64_t     archive_entry_ino64(struct archive_entry *);
 257 __LA_DECL int            archive_entry_ino_is_set(struct archive_entry *);
 258 __LA_DECL __LA_MODE_T    archive_entry_mode(struct archive_entry *);
 259 __LA_DECL time_t         archive_entry_mtime(struct archive_entry *);
 260 __LA_DECL long           archive_entry_mtime_nsec(struct archive_entry *);
 261 __LA_DECL int            archive_entry_mtime_is_set(struct archive_entry *);
 262 __LA_DECL unsigned int   archive_entry_nlink(struct archive_entry *);
 263 __LA_DECL const char    *archive_entry_pathname(struct archive_entry *);
 264 __LA_DECL const char    *archive_entry_pathname_utf8(struct archive_entry *);
 265 __LA_DECL const wchar_t *archive_entry_pathname_w(struct archive_entry *);
 266 __LA_DECL __LA_MODE_T    archive_entry_perm(struct archive_entry *);
 267 __LA_DECL dev_t          archive_entry_rdev(struct archive_entry *);
 268 __LA_DECL dev_t          archive_entry_rdevmajor(struct archive_entry *);
 269 __LA_DECL dev_t          archive_entry_rdevminor(struct archive_entry *);
 270 __LA_DECL const char    *archive_entry_sourcepath(struct archive_entry *);
 271 __LA_DECL const wchar_t *archive_entry_sourcepath_w(struct archive_entry *);
 272 __LA_DECL la_int64_t     archive_entry_size(struct archive_entry *);
 273 __LA_DECL int            archive_entry_size_is_set(struct archive_entry *);
 274 __LA_DECL const char    *archive_entry_strmode(struct archive_entry *);
 275 __LA_DECL const char    *archive_entry_symlink(struct archive_entry *);
 276 __LA_DECL const char    *archive_entry_symlink_utf8(struct archive_entry *);
 277 __LA_DECL const wchar_t *archive_entry_symlink_w(struct archive_entry *);
 278 __LA_DECL la_int64_t     archive_entry_uid(struct archive_entry *);
 279 __LA_DECL const char    *archive_entry_uname(struct archive_entry *);
 280 __LA_DECL const char    *archive_entry_uname_utf8(struct archive_entry *);
 281 __LA_DECL const wchar_t *archive_entry_uname_w(struct archive_entry *);
 282 __LA_DECL int archive_entry_is_data_encrypted(struct archive_entry *);
 283 __LA_DECL int archive_entry_is_metadata_encrypted(struct archive_entry *);
 284 __LA_DECL int archive_entry_is_encrypted(struct archive_entry *);
 285
 286 /*
 287  * Set fields in an archive_entry.
 288  *
 289  * Note: Before libarchive 2.4, there were 'set' and 'copy' versions
 290  * of the string setters.  'copy' copied the actual string, 'set' just
 291  * stored the pointer.  In libarchive 2.4 and later, strings are
 292  * always copied.
 293  */
 294
 295 __LA_DECL void  archive_entry_set_atime(struct archive_entry *, time_t, long);
 296 __LA_DECL void  archive_entry_unset_atime(struct archive_entry *);
 297 #if defined(_WIN32) && !defined(__CYGWIN__)
 298 __LA_DECL void archive_entry_copy_bhfi(struct archive_entry *, BY_HANDLE_FILE_INFORMATION *);
 299 #endif
 300 __LA_DECL void  archive_entry_set_birthtime(struct archive_entry *, time_t, long);
 301 __LA_DECL void  archive_entry_unset_birthtime(struct archive_entry *);
 302 __LA_DECL void  archive_entry_set_ctime(struct archive_entry *, time_t, long);
 303 __LA_DECL void  archive_entry_unset_ctime(struct archive_entry *);
 304 __LA_DECL void  archive_entry_set_dev(struct archive_entry *, dev_t);
 305 __LA_DECL void  archive_entry_set_devmajor(struct archive_entry *, dev_t);
 306 __LA_DECL void  archive_entry_set_devminor(struct archive_entry *, dev_t);
 307 __LA_DECL void  archive_entry_set_filetype(struct archive_entry *, unsigned int);
 308 __LA_DECL void  archive_entry_set_fflags(struct archive_entry *,
 309             unsigned long /* set */, unsigned long /* clear */);
 310 /* Returns pointer to start of first invalid token, or NULL if none. */
 311 /* Note that all recognized tokens are processed, regardless. */
 312 __LA_DECL const char *archive_entry_copy_fflags_text(struct archive_entry *,
 313             const char *);
 314 __LA_DECL const wchar_t *archive_entry_copy_fflags_text_w(struct archive_entry *,
 315             const wchar_t *);
 316 __LA_DECL void  archive_entry_set_gid(struct archive_entry *, la_int64_t);
 317 __LA_DECL void  archive_entry_set_gname(struct archive_entry *, const char *);
 318 __LA_DECL void  archive_entry_set_gname_utf8(struct archive_entry *, const char *);
 319 __LA_DECL void  archive_entry_copy_gname(struct archive_entry *, const char *);
 320 __LA_DECL void  archive_entry_copy_gname_w(struct archive_entry *, const wchar_t *);
 321 __LA_DECL int   archive_entry_update_gname_utf8(struct archive_entry *, const char *);
 322 __LA_DECL void  archive_entry_set_hardlink(struct archive_entry *, const char *);
 323 __LA_DECL void  archive_entry_set_hardlink_utf8(struct archive_entry *, const char *);
 324 __LA_DECL void  archive_entry_copy_hardlink(struct archive_entry *, const char *);
 325 __LA_DECL void  archive_entry_copy_hardlink_w(struct archive_entry *, const wchar_t *);
 326 __LA_DECL int   archive_entry_update_hardlink_utf8(struct archive_entry *, const char *);
 327 __LA_DECL void  archive_entry_set_ino(struct archive_entry *, la_int64_t);
 328 __LA_DECL void  archive_entry_set_ino64(struct archive_entry *, la_int64_t);
 329 __LA_DECL void  archive_entry_set_link(struct archive_entry *, const char *);
 330 __LA_DECL void  archive_entry_set_link_utf8(struct archive_entry *, const char *);
 331 __LA_DECL void  archive_entry_copy_link(struct archive_entry *, const char *);
 332 __LA_DECL void  archive_entry_copy_link_w(struct archive_entry *, const wchar_t *);
 333 __LA_DECL int   archive_entry_update_link_utf8(struct archive_entry *, const char *);
 334 __LA_DECL void  archive_entry_set_mode(struct archive_entry *, __LA_MODE_T);
 335 __LA_DECL void  archive_entry_set_mtime(struct archive_entry *, time_t, long);
 336 __LA_DECL void  archive_entry_unset_mtime(struct archive_entry *);
 337 __LA_DECL void  archive_entry_set_nlink(struct archive_entry *, unsigned int);
 338 __LA_DECL void  archive_entry_set_pathname(struct archive_entry *, const char *);
 339 __LA_DECL void  archive_entry_set_pathname_utf8(struct archive_entry *, const char *);
 340 __LA_DECL void  archive_entry_copy_pathname(struct archive_entry *, const char *);
 341 __LA_DECL void  archive_entry_copy_pathname_w(struct archive_entry *, const wchar_t *);
 342 __LA_DECL int   archive_entry_update_pathname_utf8(struct archive_entry *, const char *);
 343 __LA_DECL void  archive_entry_set_perm(struct archive_entry *, __LA_MODE_T);
 344 __LA_DECL void  archive_entry_set_rdev(struct archive_entry *, dev_t);
 345 __LA_DECL void  archive_entry_set_rdevmajor(struct archive_entry *, dev_t);
 346 __LA_DECL void  archive_entry_set_rdevminor(struct archive_entry *, dev_t);
 347 __LA_DECL void  archive_entry_set_size(struct archive_entry *, la_int64_t);
 348 __LA_DECL void  archive_entry_unset_size(struct archive_entry *);
 349 __LA_DECL void  archive_entry_copy_sourcepath(struct archive_entry *, const char *);
 350 __LA_DECL void  archive_entry_copy_sourcepath_w(struct archive_entry *, const wchar_t *);
 351 __LA_DECL void  archive_entry_set_symlink(struct archive_entry *, const char *);
 352 __LA_DECL void  archive_entry_set_symlink_utf8(struct archive_entry *, const char *);
 353 __LA_DECL void  archive_entry_copy_symlink(struct archive_entry *, const char *);
 354 __LA_DECL void  archive_entry_copy_symlink_w(struct archive_entry *, const wchar_t *);
 355 __LA_DECL int   archive_entry_update_symlink_utf8(struct archive_entry *, const char *);
 356 __LA_DECL void  archive_entry_set_uid(struct archive_entry *, la_int64_t);
 357 __LA_DECL void  archive_entry_set_uname(struct archive_entry *, const char *);
 358 __LA_DECL void  archive_entry_set_uname_utf8(struct archive_entry *, const char *);
 359 __LA_DECL void  archive_entry_copy_uname(struct archive_entry *, const char *);
 360 __LA_DECL void  archive_entry_copy_uname_w(struct archive_entry *, const wchar_t *);
 361 __LA_DECL int   archive_entry_update_uname_utf8(struct archive_entry *, const char *);
 362 __LA_DECL void  archive_entry_set_is_data_encrypted(struct archive_entry *, char is_encrypted);
 363 __LA_DECL void  archive_entry_set_is_metadata_encrypted(struct archive_entry *, char is_encrypted);
 364 /*
 365  * Routines to bulk copy fields to/from a platform-native "struct
 366  * stat."  Libarchive used to just store a struct stat inside of each
 367  * archive_entry object, but this created issues when trying to
 368  * manipulate archives on systems different than the ones they were
 369  * created on.
 370  *
 371  * TODO: On Linux and other LFS systems, provide both stat32 and
 372  * stat64 versions of these functions and all of the macro glue so
 373  * that archive_entry_stat is magically defined to
 374  * archive_entry_stat32 or archive_entry_stat64 as appropriate.
 375  */
 376 __LA_DECL const struct stat     *archive_entry_stat(struct archive_entry *);
 377 __LA_DECL void  archive_entry_copy_stat(struct archive_entry *, const struct stat *);
 378
 379 /*
 380  * Storage for Mac OS-specific AppleDouble metadata information.
 381  * Apple-format tar files store a separate binary blob containing
 382  * encoded metadata with ACL, extended attributes, etc.
 383  * This provides a place to store that blob.
 384  */
 385
 386 __LA_DECL const void * archive_entry_mac_metadata(struct archive_entry *, size_t *);
 387 __LA_DECL void archive_entry_copy_mac_metadata(struct archive_entry *, const void *, size_t);
 388
 389 /*
 390  * ACL routines.  This used to simply store and return text-format ACL
 391  * strings, but that proved insufficient for a number of reasons:
 392  *   = clients need control over uname/uid and gname/gid mappings
 393  *   = there are many different ACL text formats
 394  *   = would like to be able to read/convert archives containing ACLs
 395  *     on platforms that lack ACL libraries
 396  *
 397  *  This last point, in particular, forces me to implement a reasonably
 398  *  complete set of ACL support routines.
 399  */
 400
 401 /*
 402  * Permission bits.
 403  */
 404 #define ARCHIVE_ENTRY_ACL_EXECUTE             0x00000001
 405 #define ARCHIVE_ENTRY_ACL_WRITE               0x00000002
 406 #define ARCHIVE_ENTRY_ACL_READ                0x00000004
 407 #define ARCHIVE_ENTRY_ACL_READ_DATA           0x00000008
 408 #define ARCHIVE_ENTRY_ACL_LIST_DIRECTORY      0x00000008
 409 #define ARCHIVE_ENTRY_ACL_WRITE_DATA          0x00000010
 410 #define ARCHIVE_ENTRY_ACL_ADD_FILE            0x00000010
 411 #define ARCHIVE_ENTRY_ACL_APPEND_DATA         0x00000020
 412 #define ARCHIVE_ENTRY_ACL_ADD_SUBDIRECTORY    0x00000020
 413 #define ARCHIVE_ENTRY_ACL_READ_NAMED_ATTRS    0x00000040
 414 #define ARCHIVE_ENTRY_ACL_WRITE_NAMED_ATTRS   0x00000080
 415 #define ARCHIVE_ENTRY_ACL_DELETE_CHILD        0x00000100
 416 #define ARCHIVE_ENTRY_ACL_READ_ATTRIBUTES     0x00000200
 417 #define ARCHIVE_ENTRY_ACL_WRITE_ATTRIBUTES    0x00000400
 418 #define ARCHIVE_ENTRY_ACL_DELETE              0x00000800
 419 #define ARCHIVE_ENTRY_ACL_READ_ACL            0x00001000
 420 #define ARCHIVE_ENTRY_ACL_WRITE_ACL           0x00002000
 421 #define ARCHIVE_ENTRY_ACL_WRITE_OWNER         0x00004000
 422 #define ARCHIVE_ENTRY_ACL_SYNCHRONIZE         0x00008000
 423
 424 #define ARCHIVE_ENTRY_ACL_PERMS_POSIX1E                 \
 425         (ARCHIVE_ENTRY_ACL_EXECUTE                      \
 426             | ARCHIVE_ENTRY_ACL_WRITE                   \
 427             | ARCHIVE_ENTRY_ACL_READ)
 428
 429 #define ARCHIVE_ENTRY_ACL_PERMS_NFS4                    \
 430         (ARCHIVE_ENTRY_ACL_EXECUTE                      \
 431             | ARCHIVE_ENTRY_ACL_READ_DATA               \
 432             | ARCHIVE_ENTRY_ACL_LIST_DIRECTORY          \
 433             | ARCHIVE_ENTRY_ACL_WRITE_DATA              \
 434             | ARCHIVE_ENTRY_ACL_ADD_FILE                \
 435             | ARCHIVE_ENTRY_ACL_APPEND_DATA             \
 436             | ARCHIVE_ENTRY_ACL_ADD_SUBDIRECTORY        \
 437             | ARCHIVE_ENTRY_ACL_READ_NAMED_ATTRS        \
 438             | ARCHIVE_ENTRY_ACL_WRITE_NAMED_ATTRS       \
 439             | ARCHIVE_ENTRY_ACL_DELETE_CHILD            \
 440             | ARCHIVE_ENTRY_ACL_READ_ATTRIBUTES         \
 441             | ARCHIVE_ENTRY_ACL_WRITE_ATTRIBUTES        \
 442             | ARCHIVE_ENTRY_ACL_DELETE                  \
 443             | ARCHIVE_ENTRY_ACL_READ_ACL                \
 444             | ARCHIVE_ENTRY_ACL_WRITE_ACL               \
 445             | ARCHIVE_ENTRY_ACL_WRITE_OWNER             \
 446             | ARCHIVE_ENTRY_ACL_SYNCHRONIZE)
 447
 448 /*
 449  * Inheritance values (NFS4 ACLs only); included in permset.
 450  */
 451 #define ARCHIVE_ENTRY_ACL_ENTRY_INHERITED                   0x01000000
 452 #define ARCHIVE_ENTRY_ACL_ENTRY_FILE_INHERIT                0x02000000
 453 #define ARCHIVE_ENTRY_ACL_ENTRY_DIRECTORY_INHERIT           0x04000000
 454 #define ARCHIVE_ENTRY_ACL_ENTRY_NO_PROPAGATE_INHERIT        0x08000000
 455 #define ARCHIVE_ENTRY_ACL_ENTRY_INHERIT_ONLY                0x10000000
 456 #define ARCHIVE_ENTRY_ACL_ENTRY_SUCCESSFUL_ACCESS           0x20000000
 457 #define ARCHIVE_ENTRY_ACL_ENTRY_FAILED_ACCESS               0x40000000
 458
 459 #define ARCHIVE_ENTRY_ACL_INHERITANCE_NFS4                      \
 460         (ARCHIVE_ENTRY_ACL_ENTRY_FILE_INHERIT                   \
 461             | ARCHIVE_ENTRY_ACL_ENTRY_DIRECTORY_INHERIT         \
 462             | ARCHIVE_ENTRY_ACL_ENTRY_NO_PROPAGATE_INHERIT      \
 463             | ARCHIVE_ENTRY_ACL_ENTRY_INHERIT_ONLY              \
 464             | ARCHIVE_ENTRY_ACL_ENTRY_SUCCESSFUL_ACCESS         \
 465             | ARCHIVE_ENTRY_ACL_ENTRY_FAILED_ACCESS             \
 466             | ARCHIVE_ENTRY_ACL_ENTRY_INHERITED)
 467
 468 /* We need to be able to specify combinations of these. */
 469 #define ARCHIVE_ENTRY_ACL_TYPE_ACCESS   0x00000100  /* POSIX.1e only */
 470 #define ARCHIVE_ENTRY_ACL_TYPE_DEFAULT  0x00000200  /* POSIX.1e only */
 471 #define ARCHIVE_ENTRY_ACL_TYPE_ALLOW    0x00000400 /* NFS4 only */
 472 #define ARCHIVE_ENTRY_ACL_TYPE_DENY     0x00000800 /* NFS4 only */
 473 #define ARCHIVE_ENTRY_ACL_TYPE_AUDIT    0x00001000 /* NFS4 only */
 474 #define ARCHIVE_ENTRY_ACL_TYPE_ALARM    0x00002000 /* NFS4 only */
 475 #define ARCHIVE_ENTRY_ACL_TYPE_POSIX1E  (ARCHIVE_ENTRY_ACL_TYPE_ACCESS \
 476             | ARCHIVE_ENTRY_ACL_TYPE_DEFAULT)
 477 #define ARCHIVE_ENTRY_ACL_TYPE_NFS4     (ARCHIVE_ENTRY_ACL_TYPE_ALLOW \
 478             | ARCHIVE_ENTRY_ACL_TYPE_DENY \
 479             | ARCHIVE_ENTRY_ACL_TYPE_AUDIT \
 480             | ARCHIVE_ENTRY_ACL_TYPE_ALARM)
 481
 482 /* Tag values mimic POSIX.1e */
 483 #define ARCHIVE_ENTRY_ACL_USER          10001   /* Specified user. */
 484 #define ARCHIVE_ENTRY_ACL_USER_OBJ      10002   /* User who owns the file. */
 485 #define ARCHIVE_ENTRY_ACL_GROUP         10003   /* Specified group. */
 486 #define ARCHIVE_ENTRY_ACL_GROUP_OBJ     10004   /* Group who owns the file. */
 487 #define ARCHIVE_ENTRY_ACL_MASK          10005   /* Modify group access (POSIX.1e only) */
 488 #define ARCHIVE_ENTRY_ACL_OTHER         10006   /* Public (POSIX.1e only) */
 489 #define ARCHIVE_ENTRY_ACL_EVERYONE      10107   /* Everyone (NFS4 only) */
 490
 491 /*
 492  * Set the ACL by clearing it and adding entries one at a time.
 493  * Unlike the POSIX.1e ACL routines, you must specify the type
 494  * (access/default) for each entry.  Internally, the ACL data is just
 495  * a soup of entries.  API calls here allow you to retrieve just the
 496  * entries of interest.  This design (which goes against the spirit of
 497  * POSIX.1e) is useful for handling archive formats that combine
 498  * default and access information in a single ACL list.
 499  */
 500 __LA_DECL void   archive_entry_acl_clear(struct archive_entry *);
 501 __LA_DECL int    archive_entry_acl_add_entry(struct archive_entry *,
 502             int /* type */, int /* permset */, int /* tag */,
 503             int /* qual */, const char * /* name */);
 504 __LA_DECL int    archive_entry_acl_add_entry_w(struct archive_entry *,
 505             int /* type */, int /* permset */, int /* tag */,
 506             int /* qual */, const wchar_t * /* name */);
 507
 508 /*
 509  * To retrieve the ACL, first "reset", then repeatedly ask for the
 510  * "next" entry.  The want_type parameter allows you to request only
 511  * certain types of entries.
 512  */
 513 __LA_DECL int    archive_entry_acl_reset(struct archive_entry *, int /* want_type */);
 514 __LA_DECL int    archive_entry_acl_next(struct archive_entry *, int /* want_type */,
 515             int * /* type */, int * /* permset */, int * /* tag */,
 516             int * /* qual */, const char ** /* name */);
 517 __LA_DECL int    archive_entry_acl_next_w(struct archive_entry *, int /* want_type */,
 518             int * /* type */, int * /* permset */, int * /* tag */,
 519             int * /* qual */, const wchar_t ** /* name */);
 520
 521 /*
 522  * Construct a text-format ACL.  The flags argument is a bitmask that
 523  * can include any of the following:
 524  *
 525  * Flags only for archive entries with POSIX.1e ACL:
 526  * ARCHIVE_ENTRY_ACL_TYPE_ACCESS - Include POSIX.1e "access" entries.
 527  * ARCHIVE_ENTRY_ACL_TYPE_DEFAULT - Include POSIX.1e "default" entries.
 528  * ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT - Include "default:" before each
 529  *    default ACL entry.
 530  * ARCHIVE_ENTRY_ACL_STYLE_SOLARIS - Output only one colon after "other" and
 531  *    "mask" entries.
 532  *
 533  * Flags only for archive entries with NFSv4 ACL:
 534  * ARCHIVE_ENTRY_ACL_STYLE_COMPACT - Do not output the minus character for
 535  *    unset permissions and flags in NFSv4 ACL permission and flag fields
 536  *
 537  * Flags for for archive entries with POSIX.1e ACL or NFSv4 ACL:
 538  * ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID - Include extra numeric ID field in
 539  *    each ACL entry.
 540  * ARCHIVE_ENTRY_ACL_STYLE_SEPARATOR_COMMA - Separate entries with comma
 541  *    instead of newline.
 542  */
 543 #define ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID        0x00000001
 544 #define ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT    0x00000002
 545 #define ARCHIVE_ENTRY_ACL_STYLE_SOLARIS         0x00000004
 546 #define ARCHIVE_ENTRY_ACL_STYLE_SEPARATOR_COMMA 0x00000008
 547 #define ARCHIVE_ENTRY_ACL_STYLE_COMPACT         0x00000010
 548
 549 __LA_DECL wchar_t *archive_entry_acl_to_text_w(struct archive_entry *,
 550             la_ssize_t * /* len */, int /* flags */);
 551 __LA_DECL char *archive_entry_acl_to_text(struct archive_entry *,
 552             la_ssize_t * /* len */, int /* flags */);
 553 __LA_DECL int archive_entry_acl_from_text_w(struct archive_entry *,
 554             const wchar_t * /* wtext */, int /* type */);
 555 __LA_DECL int archive_entry_acl_from_text(struct archive_entry *,
 556             const char * /* text */, int /* type */);
 557
 558 /* Deprecated constants */
 559 #define OLD_ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID            1024
 560 #define OLD_ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT        2048
 561
 562 /* Deprecated functions */
 563 __LA_DECL const wchar_t *archive_entry_acl_text_w(struct archive_entry *,
 564                     int /* flags */) __LA_DEPRECATED;
 565 __LA_DECL const char *archive_entry_acl_text(struct archive_entry *,
 566                     int /* flags */) __LA_DEPRECATED;
 567
 568 /* Return bitmask of ACL types in an archive entry */
 569 __LA_DECL int    archive_entry_acl_types(struct archive_entry *);
 570
 571 /* Return a count of entries matching 'want_type' */
 572 __LA_DECL int    archive_entry_acl_count(struct archive_entry *, int /* want_type */);
 573
 574 /* Return an opaque ACL object. */
 575 /* There's not yet anything clients can actually do with this... */
 576 struct archive_acl;
 577 __LA_DECL struct archive_acl *archive_entry_acl(struct archive_entry *);
 578
 579 /*
 580  * extended attributes
 581  */
 582
 583 __LA_DECL void   archive_entry_xattr_clear(struct archive_entry *);
 584 __LA_DECL void   archive_entry_xattr_add_entry(struct archive_entry *,
 585             const char * /* name */, const void * /* value */,
 586             size_t /* size */);
 587
 588 /*
 589  * To retrieve the xattr list, first "reset", then repeatedly ask for the
 590  * "next" entry.
 591  */
 592
 593 __LA_DECL int   archive_entry_xattr_count(struct archive_entry *);
 594 __LA_DECL int   archive_entry_xattr_reset(struct archive_entry *);
 595 __LA_DECL int   archive_entry_xattr_next(struct archive_entry *,
 596             const char ** /* name */, const void ** /* value */, size_t *);
 597
 598 /*
 599  * sparse
 600  */
 601
 602 __LA_DECL void   archive_entry_sparse_clear(struct archive_entry *);
 603 __LA_DECL void   archive_entry_sparse_add_entry(struct archive_entry *,
 604             la_int64_t /* offset */, la_int64_t /* length */);
 605
 606 /*
 607  * To retrieve the xattr list, first "reset", then repeatedly ask for the
 608  * "next" entry.
 609  */
 610
 611 __LA_DECL int   archive_entry_sparse_count(struct archive_entry *);
 612 __LA_DECL int   archive_entry_sparse_reset(struct archive_entry *);
 613 __LA_DECL int   archive_entry_sparse_next(struct archive_entry *,
 614             la_int64_t * /* offset */, la_int64_t * /* length */);
 615
 616 /*
 617  * Utility to match up hardlinks.
 618  *
 619  * The 'struct archive_entry_linkresolver' is a cache of archive entries
 620  * for files with multiple links.  Here's how to use it:
 621  *   1. Create a lookup object with archive_entry_linkresolver_new()
 622  *   2. Tell it the archive format you're using.
 623  *   3. Hand each archive_entry to archive_entry_linkify().
 624  *      That function will return 0, 1, or 2 entries that should
 625  *      be written.
 626  *   4. Call archive_entry_linkify(resolver, NULL) until
 627  *      no more entries are returned.
 628  *   5. Call archive_entry_linkresolver_free(resolver) to free resources.
 629  *
 630  * The entries returned have their hardlink and size fields updated
 631  * appropriately.  If an entry is passed in that does not refer to
 632  * a file with multiple links, it is returned unchanged.  The intention
 633  * is that you should be able to simply filter all entries through
 634  * this machine.
 635  *
 636  * To make things more efficient, be sure that each entry has a valid
 637  * nlinks value.  The hardlink cache uses this to track when all links
 638  * have been found.  If the nlinks value is zero, it will keep every
 639  * name in the cache indefinitely, which can use a lot of memory.
 640  *
 641  * Note that archive_entry_size() is reset to zero if the file
 642  * body should not be written to the archive.  Pay attention!
 643  */
 644 struct archive_entry_linkresolver;
 645
 646 /*
 647  * There are three different strategies for marking hardlinks.
 648  * The descriptions below name them after the best-known
 649  * formats that rely on each strategy:
 650  *
 651  * "Old cpio" is the simplest, it always returns any entry unmodified.
 652  *    As far as I know, only cpio formats use this.  Old cpio archives
 653  *    store every link with the full body; the onus is on the dearchiver
 654  *    to detect and properly link the files as they are restored.
 655  * "tar" is also pretty simple; it caches a copy the first time it sees
 656  *    any link.  Subsequent appearances are modified to be hardlink
 657  *    references to the first one without any body.  Used by all tar
 658  *    formats, although the newest tar formats permit the "old cpio" strategy
 659  *    as well.  This strategy is very simple for the dearchiver,
 660  *    and reasonably straightforward for the archiver.
 661  * "new cpio" is trickier.  It stores the body only with the last
 662  *    occurrence.  The complication is that we might not
 663  *    see every link to a particular file in a single session, so
 664  *    there's no easy way to know when we've seen the last occurrence.
 665  *    The solution here is to queue one link until we see the next.
 666  *    At the end of the session, you can enumerate any remaining
 667  *    entries by calling archive_entry_linkify(NULL) and store those
 668  *    bodies.  If you have a file with three links l1, l2, and l3,
 669  *    you'll get the following behavior if you see all three links:
 670  *           linkify(l1) => NULL   (the resolver stores l1 internally)
 671  *           linkify(l2) => l1     (resolver stores l2, you write l1)
 672  *           linkify(l3) => l2, l3 (all links seen, you can write both).
 673  *    If you only see l1 and l2, you'll get this behavior:
 674  *           linkify(l1) => NULL
 675  *           linkify(l2) => l1
 676  *           linkify(NULL) => l2   (at end, you retrieve remaining links)
 677  *    As the name suggests, this strategy is used by newer cpio variants.
 678  *    It's noticeably more complex for the archiver, slightly more complex
 679  *    for the dearchiver than the tar strategy, but makes it straightforward
 680  *    to restore a file using any link by simply continuing to scan until
 681  *    you see a link that is stored with a body.  In contrast, the tar
 682  *    strategy requires you to rescan the archive from the beginning to
 683  *    correctly extract an arbitrary link.
 684  */
 685
 686 __LA_DECL struct archive_entry_linkresolver *archive_entry_linkresolver_new(void);
 687 __LA_DECL void archive_entry_linkresolver_set_strategy(
 688         struct archive_entry_linkresolver *, int /* format_code */);
 689 __LA_DECL void archive_entry_linkresolver_free(struct archive_entry_linkresolver *);
 690 __LA_DECL void archive_entry_linkify(struct archive_entry_linkresolver *,
 691     struct archive_entry **, struct archive_entry **);
 692 __LA_DECL struct archive_entry *archive_entry_partial_links(
 693     struct archive_entry_linkresolver *res, unsigned int *links);
 694
 695 #ifdef __cplusplus
 696 }
 697 #endif
 698
 699 /* This is meaningless outside of this header. */
 700 #undef __LA_DECL
 701
 702 #endif /* !ARCHIVE_ENTRY_H_INCLUDED */