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