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