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