Warning: That file was not part of the compilation database. It may have many parsing errors.

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: head/lib/libarchive/archive_entry.h 201096 2009-12-28 02:41:27Z kientzle $
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 3003003
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 * Basic object manipulation
195 */
196
197__LA_DECL struct archive_entry *archive_entry_clear(struct archive_entry *);
198/* The 'clone' function does a deep copy; all of the strings are copied too. */
199__LA_DECL struct archive_entry *archive_entry_clone(struct archive_entry *);
200__LA_DECL void archive_entry_free(struct archive_entry *);
201__LA_DECL struct archive_entry *archive_entry_new(void);
202
203/*
204 * This form of archive_entry_new2() will pull character-set
205 * conversion information from the specified archive handle. The
206 * older archive_entry_new(void) form is equivalent to calling
207 * archive_entry_new2(NULL) and will result in the use of an internal
208 * default character-set conversion.
209 */
210__LA_DECL struct archive_entry *archive_entry_new2(struct archive *);
211
212/*
213 * Retrieve fields from an archive_entry.
214 *
215 * There are a number of implicit conversions among these fields. For
216 * example, if a regular string field is set and you read the _w wide
217 * character field, the entry will implicitly convert narrow-to-wide
218 * using the current locale. Similarly, dev values are automatically
219 * updated when you write devmajor or devminor and vice versa.
220 *
221 * In addition, fields can be "set" or "unset." Unset string fields
222 * return NULL, non-string fields have _is_set() functions to test
223 * whether they've been set. You can "unset" a string field by
224 * assigning NULL; non-string fields have _unset() functions to
225 * unset them.
226 *
227 * Note: There is one ambiguity in the above; string fields will
228 * also return NULL when implicit character set conversions fail.
229 * This is usually what you want.
230 */
231__LA_DECL time_t archive_entry_atime(struct archive_entry *);
232__LA_DECL long archive_entry_atime_nsec(struct archive_entry *);
233__LA_DECL int archive_entry_atime_is_set(struct archive_entry *);
234__LA_DECL time_t archive_entry_birthtime(struct archive_entry *);
235__LA_DECL long archive_entry_birthtime_nsec(struct archive_entry *);
236__LA_DECL int archive_entry_birthtime_is_set(struct archive_entry *);
237__LA_DECL time_t archive_entry_ctime(struct archive_entry *);
238__LA_DECL long archive_entry_ctime_nsec(struct archive_entry *);
239__LA_DECL int archive_entry_ctime_is_set(struct archive_entry *);
240__LA_DECL dev_t archive_entry_dev(struct archive_entry *);
241__LA_DECL int archive_entry_dev_is_set(struct archive_entry *);
242__LA_DECL dev_t archive_entry_devmajor(struct archive_entry *);
243__LA_DECL dev_t archive_entry_devminor(struct archive_entry *);
244__LA_DECL __LA_MODE_T archive_entry_filetype(struct archive_entry *);
245__LA_DECL void archive_entry_fflags(struct archive_entry *,
246 unsigned long * /* set */,
247 unsigned long * /* clear */);
248__LA_DECL const char *archive_entry_fflags_text(struct archive_entry *);
249__LA_DECL la_int64_t archive_entry_gid(struct archive_entry *);
250__LA_DECL const char *archive_entry_gname(struct archive_entry *);
251__LA_DECL const char *archive_entry_gname_utf8(struct archive_entry *);
252__LA_DECL const wchar_t *archive_entry_gname_w(struct archive_entry *);
253__LA_DECL const char *archive_entry_hardlink(struct archive_entry *);
254__LA_DECL const char *archive_entry_hardlink_utf8(struct archive_entry *);
255__LA_DECL const wchar_t *archive_entry_hardlink_w(struct archive_entry *);
256__LA_DECL la_int64_t archive_entry_ino(struct archive_entry *);
257__LA_DECL la_int64_t archive_entry_ino64(struct archive_entry *);
258__LA_DECL int archive_entry_ino_is_set(struct archive_entry *);
259__LA_DECL __LA_MODE_T archive_entry_mode(struct archive_entry *);
260__LA_DECL time_t archive_entry_mtime(struct archive_entry *);
261__LA_DECL long archive_entry_mtime_nsec(struct archive_entry *);
262__LA_DECL int archive_entry_mtime_is_set(struct archive_entry *);
263__LA_DECL unsigned int archive_entry_nlink(struct archive_entry *);
264__LA_DECL const char *archive_entry_pathname(struct archive_entry *);
265__LA_DECL const char *archive_entry_pathname_utf8(struct archive_entry *);
266__LA_DECL const wchar_t *archive_entry_pathname_w(struct archive_entry *);
267__LA_DECL __LA_MODE_T archive_entry_perm(struct archive_entry *);
268__LA_DECL dev_t archive_entry_rdev(struct archive_entry *);
269__LA_DECL dev_t archive_entry_rdevmajor(struct archive_entry *);
270__LA_DECL dev_t archive_entry_rdevminor(struct archive_entry *);
271__LA_DECL const char *archive_entry_sourcepath(struct archive_entry *);
272__LA_DECL const wchar_t *archive_entry_sourcepath_w(struct archive_entry *);
273__LA_DECL la_int64_t archive_entry_size(struct archive_entry *);
274__LA_DECL int archive_entry_size_is_set(struct archive_entry *);
275__LA_DECL const char *archive_entry_strmode(struct archive_entry *);
276__LA_DECL const char *archive_entry_symlink(struct archive_entry *);
277__LA_DECL const char *archive_entry_symlink_utf8(struct archive_entry *);
278__LA_DECL const wchar_t *archive_entry_symlink_w(struct archive_entry *);
279__LA_DECL la_int64_t archive_entry_uid(struct archive_entry *);
280__LA_DECL const char *archive_entry_uname(struct archive_entry *);
281__LA_DECL const char *archive_entry_uname_utf8(struct archive_entry *);
282__LA_DECL const wchar_t *archive_entry_uname_w(struct archive_entry *);
283__LA_DECL int archive_entry_is_data_encrypted(struct archive_entry *);
284__LA_DECL int archive_entry_is_metadata_encrypted(struct archive_entry *);
285__LA_DECL int archive_entry_is_encrypted(struct archive_entry *);
286
287/*
288 * Set fields in an archive_entry.
289 *
290 * Note: Before libarchive 2.4, there were 'set' and 'copy' versions
291 * of the string setters. 'copy' copied the actual string, 'set' just
292 * stored the pointer. In libarchive 2.4 and later, strings are
293 * always copied.
294 */
295
296__LA_DECL void archive_entry_set_atime(struct archive_entry *, time_t, long);
297__LA_DECL void archive_entry_unset_atime(struct archive_entry *);
298#if defined(_WIN32) && !defined(__CYGWIN__)
299__LA_DECL void archive_entry_copy_bhfi(struct archive_entry *, BY_HANDLE_FILE_INFORMATION *);
300#endif
301__LA_DECL void archive_entry_set_birthtime(struct archive_entry *, time_t, long);
302__LA_DECL void archive_entry_unset_birthtime(struct archive_entry *);
303__LA_DECL void archive_entry_set_ctime(struct archive_entry *, time_t, long);
304__LA_DECL void archive_entry_unset_ctime(struct archive_entry *);
305__LA_DECL void archive_entry_set_dev(struct archive_entry *, dev_t);
306__LA_DECL void archive_entry_set_devmajor(struct archive_entry *, dev_t);
307__LA_DECL void archive_entry_set_devminor(struct archive_entry *, dev_t);
308__LA_DECL void archive_entry_set_filetype(struct archive_entry *, unsigned int);
309__LA_DECL void archive_entry_set_fflags(struct archive_entry *,
310 unsigned long /* set */, unsigned long /* clear */);
311/* Returns pointer to start of first invalid token, or NULL if none. */
312/* Note that all recognized tokens are processed, regardless. */
313__LA_DECL const char *archive_entry_copy_fflags_text(struct archive_entry *,
314 const char *);
315__LA_DECL const wchar_t *archive_entry_copy_fflags_text_w(struct archive_entry *,
316 const wchar_t *);
317__LA_DECL void archive_entry_set_gid(struct archive_entry *, la_int64_t);
318__LA_DECL void archive_entry_set_gname(struct archive_entry *, const char *);
319__LA_DECL void archive_entry_set_gname_utf8(struct archive_entry *, const char *);
320__LA_DECL void archive_entry_copy_gname(struct archive_entry *, const char *);
321__LA_DECL void archive_entry_copy_gname_w(struct archive_entry *, const wchar_t *);
322__LA_DECL int archive_entry_update_gname_utf8(struct archive_entry *, const char *);
323__LA_DECL void archive_entry_set_hardlink(struct archive_entry *, const char *);
324__LA_DECL void archive_entry_set_hardlink_utf8(struct archive_entry *, const char *);
325__LA_DECL void archive_entry_copy_hardlink(struct archive_entry *, const char *);
326__LA_DECL void archive_entry_copy_hardlink_w(struct archive_entry *, const wchar_t *);
327__LA_DECL int archive_entry_update_hardlink_utf8(struct archive_entry *, const char *);
328__LA_DECL void archive_entry_set_ino(struct archive_entry *, la_int64_t);
329__LA_DECL void archive_entry_set_ino64(struct archive_entry *, la_int64_t);
330__LA_DECL void archive_entry_set_link(struct archive_entry *, const char *);
331__LA_DECL void archive_entry_set_link_utf8(struct archive_entry *, const char *);
332__LA_DECL void archive_entry_copy_link(struct archive_entry *, const char *);
333__LA_DECL void archive_entry_copy_link_w(struct archive_entry *, const wchar_t *);
334__LA_DECL int archive_entry_update_link_utf8(struct archive_entry *, const char *);
335__LA_DECL void archive_entry_set_mode(struct archive_entry *, __LA_MODE_T);
336__LA_DECL void archive_entry_set_mtime(struct archive_entry *, time_t, long);
337__LA_DECL void archive_entry_unset_mtime(struct archive_entry *);
338__LA_DECL void archive_entry_set_nlink(struct archive_entry *, unsigned int);
339__LA_DECL void archive_entry_set_pathname(struct archive_entry *, const char *);
340__LA_DECL void archive_entry_set_pathname_utf8(struct archive_entry *, const char *);
341__LA_DECL void archive_entry_copy_pathname(struct archive_entry *, const char *);
342__LA_DECL void archive_entry_copy_pathname_w(struct archive_entry *, const wchar_t *);
343__LA_DECL int archive_entry_update_pathname_utf8(struct archive_entry *, const char *);
344__LA_DECL void archive_entry_set_perm(struct archive_entry *, __LA_MODE_T);
345__LA_DECL void archive_entry_set_rdev(struct archive_entry *, dev_t);
346__LA_DECL void archive_entry_set_rdevmajor(struct archive_entry *, dev_t);
347__LA_DECL void archive_entry_set_rdevminor(struct archive_entry *, dev_t);
348__LA_DECL void archive_entry_set_size(struct archive_entry *, la_int64_t);
349__LA_DECL void archive_entry_unset_size(struct archive_entry *);
350__LA_DECL void archive_entry_copy_sourcepath(struct archive_entry *, const char *);
351__LA_DECL void archive_entry_copy_sourcepath_w(struct archive_entry *, const wchar_t *);
352__LA_DECL void archive_entry_set_symlink(struct archive_entry *, const char *);
353__LA_DECL void archive_entry_set_symlink_utf8(struct archive_entry *, const char *);
354__LA_DECL void archive_entry_copy_symlink(struct archive_entry *, const char *);
355__LA_DECL void archive_entry_copy_symlink_w(struct archive_entry *, const wchar_t *);
356__LA_DECL int archive_entry_update_symlink_utf8(struct archive_entry *, const char *);
357__LA_DECL void archive_entry_set_uid(struct archive_entry *, la_int64_t);
358__LA_DECL void archive_entry_set_uname(struct archive_entry *, const char *);
359__LA_DECL void archive_entry_set_uname_utf8(struct archive_entry *, const char *);
360__LA_DECL void archive_entry_copy_uname(struct archive_entry *, const char *);
361__LA_DECL void archive_entry_copy_uname_w(struct archive_entry *, const wchar_t *);
362__LA_DECL int archive_entry_update_uname_utf8(struct archive_entry *, const char *);
363__LA_DECL void archive_entry_set_is_data_encrypted(struct archive_entry *, char is_encrypted);
364__LA_DECL void archive_entry_set_is_metadata_encrypted(struct archive_entry *, char is_encrypted);
365/*
366 * Routines to bulk copy fields to/from a platform-native "struct
367 * stat." Libarchive used to just store a struct stat inside of each
368 * archive_entry object, but this created issues when trying to
369 * manipulate archives on systems different than the ones they were
370 * created on.
371 *
372 * TODO: On Linux and other LFS systems, provide both stat32 and
373 * stat64 versions of these functions and all of the macro glue so
374 * that archive_entry_stat is magically defined to
375 * archive_entry_stat32 or archive_entry_stat64 as appropriate.
376 */
377__LA_DECL const struct stat *archive_entry_stat(struct archive_entry *);
378__LA_DECL void archive_entry_copy_stat(struct archive_entry *, const struct stat *);
379
380/*
381 * Storage for Mac OS-specific AppleDouble metadata information.
382 * Apple-format tar files store a separate binary blob containing
383 * encoded metadata with ACL, extended attributes, etc.
384 * This provides a place to store that blob.
385 */
386
387__LA_DECL const void * archive_entry_mac_metadata(struct archive_entry *, size_t *);
388__LA_DECL void archive_entry_copy_mac_metadata(struct archive_entry *, const void *, size_t);
389
390/*
391 * ACL routines. This used to simply store and return text-format ACL
392 * strings, but that proved insufficient for a number of reasons:
393 * = clients need control over uname/uid and gname/gid mappings
394 * = there are many different ACL text formats
395 * = would like to be able to read/convert archives containing ACLs
396 * on platforms that lack ACL libraries
397 *
398 * This last point, in particular, forces me to implement a reasonably
399 * complete set of ACL support routines.
400 */
401
402/*
403 * Permission bits.
404 */
405#define ARCHIVE_ENTRY_ACL_EXECUTE 0x00000001
406#define ARCHIVE_ENTRY_ACL_WRITE 0x00000002
407#define ARCHIVE_ENTRY_ACL_READ 0x00000004
408#define ARCHIVE_ENTRY_ACL_READ_DATA 0x00000008
409#define ARCHIVE_ENTRY_ACL_LIST_DIRECTORY 0x00000008
410#define ARCHIVE_ENTRY_ACL_WRITE_DATA 0x00000010
411#define ARCHIVE_ENTRY_ACL_ADD_FILE 0x00000010
412#define ARCHIVE_ENTRY_ACL_APPEND_DATA 0x00000020
413#define ARCHIVE_ENTRY_ACL_ADD_SUBDIRECTORY 0x00000020
414#define ARCHIVE_ENTRY_ACL_READ_NAMED_ATTRS 0x00000040
415#define ARCHIVE_ENTRY_ACL_WRITE_NAMED_ATTRS 0x00000080
416#define ARCHIVE_ENTRY_ACL_DELETE_CHILD 0x00000100
417#define ARCHIVE_ENTRY_ACL_READ_ATTRIBUTES 0x00000200
418#define ARCHIVE_ENTRY_ACL_WRITE_ATTRIBUTES 0x00000400
419#define ARCHIVE_ENTRY_ACL_DELETE 0x00000800
420#define ARCHIVE_ENTRY_ACL_READ_ACL 0x00001000
421#define ARCHIVE_ENTRY_ACL_WRITE_ACL 0x00002000
422#define ARCHIVE_ENTRY_ACL_WRITE_OWNER 0x00004000
423#define ARCHIVE_ENTRY_ACL_SYNCHRONIZE 0x00008000
424
425#define ARCHIVE_ENTRY_ACL_PERMS_POSIX1E \
426 (ARCHIVE_ENTRY_ACL_EXECUTE \
427 | ARCHIVE_ENTRY_ACL_WRITE \
428 | ARCHIVE_ENTRY_ACL_READ)
429
430#define ARCHIVE_ENTRY_ACL_PERMS_NFS4 \
431 (ARCHIVE_ENTRY_ACL_EXECUTE \
432 | ARCHIVE_ENTRY_ACL_READ_DATA \
433 | ARCHIVE_ENTRY_ACL_LIST_DIRECTORY \
434 | ARCHIVE_ENTRY_ACL_WRITE_DATA \
435 | ARCHIVE_ENTRY_ACL_ADD_FILE \
436 | ARCHIVE_ENTRY_ACL_APPEND_DATA \
437 | ARCHIVE_ENTRY_ACL_ADD_SUBDIRECTORY \
438 | ARCHIVE_ENTRY_ACL_READ_NAMED_ATTRS \
439 | ARCHIVE_ENTRY_ACL_WRITE_NAMED_ATTRS \
440 | ARCHIVE_ENTRY_ACL_DELETE_CHILD \
441 | ARCHIVE_ENTRY_ACL_READ_ATTRIBUTES \
442 | ARCHIVE_ENTRY_ACL_WRITE_ATTRIBUTES \
443 | ARCHIVE_ENTRY_ACL_DELETE \
444 | ARCHIVE_ENTRY_ACL_READ_ACL \
445 | ARCHIVE_ENTRY_ACL_WRITE_ACL \
446 | ARCHIVE_ENTRY_ACL_WRITE_OWNER \
447 | ARCHIVE_ENTRY_ACL_SYNCHRONIZE)
448
449/*
450 * Inheritance values (NFS4 ACLs only); included in permset.
451 */
452#define ARCHIVE_ENTRY_ACL_ENTRY_INHERITED 0x01000000
453#define ARCHIVE_ENTRY_ACL_ENTRY_FILE_INHERIT 0x02000000
454#define ARCHIVE_ENTRY_ACL_ENTRY_DIRECTORY_INHERIT 0x04000000
455#define ARCHIVE_ENTRY_ACL_ENTRY_NO_PROPAGATE_INHERIT 0x08000000
456#define ARCHIVE_ENTRY_ACL_ENTRY_INHERIT_ONLY 0x10000000
457#define ARCHIVE_ENTRY_ACL_ENTRY_SUCCESSFUL_ACCESS 0x20000000
458#define ARCHIVE_ENTRY_ACL_ENTRY_FAILED_ACCESS 0x40000000
459
460#define ARCHIVE_ENTRY_ACL_INHERITANCE_NFS4 \
461 (ARCHIVE_ENTRY_ACL_ENTRY_FILE_INHERIT \
462 | ARCHIVE_ENTRY_ACL_ENTRY_DIRECTORY_INHERIT \
463 | ARCHIVE_ENTRY_ACL_ENTRY_NO_PROPAGATE_INHERIT \
464 | ARCHIVE_ENTRY_ACL_ENTRY_INHERIT_ONLY \
465 | ARCHIVE_ENTRY_ACL_ENTRY_SUCCESSFUL_ACCESS \
466 | ARCHIVE_ENTRY_ACL_ENTRY_FAILED_ACCESS \
467 | ARCHIVE_ENTRY_ACL_ENTRY_INHERITED)
468
469/* We need to be able to specify combinations of these. */
470#define ARCHIVE_ENTRY_ACL_TYPE_ACCESS 0x00000100 /* POSIX.1e only */
471#define ARCHIVE_ENTRY_ACL_TYPE_DEFAULT 0x00000200 /* POSIX.1e only */
472#define ARCHIVE_ENTRY_ACL_TYPE_ALLOW 0x00000400 /* NFS4 only */
473#define ARCHIVE_ENTRY_ACL_TYPE_DENY 0x00000800 /* NFS4 only */
474#define ARCHIVE_ENTRY_ACL_TYPE_AUDIT 0x00001000 /* NFS4 only */
475#define ARCHIVE_ENTRY_ACL_TYPE_ALARM 0x00002000 /* NFS4 only */
476#define ARCHIVE_ENTRY_ACL_TYPE_POSIX1E (ARCHIVE_ENTRY_ACL_TYPE_ACCESS \
477 | ARCHIVE_ENTRY_ACL_TYPE_DEFAULT)
478#define ARCHIVE_ENTRY_ACL_TYPE_NFS4 (ARCHIVE_ENTRY_ACL_TYPE_ALLOW \
479 | ARCHIVE_ENTRY_ACL_TYPE_DENY \
480 | ARCHIVE_ENTRY_ACL_TYPE_AUDIT \
481 | ARCHIVE_ENTRY_ACL_TYPE_ALARM)
482
483/* Tag values mimic POSIX.1e */
484#define ARCHIVE_ENTRY_ACL_USER 10001 /* Specified user. */
485#define ARCHIVE_ENTRY_ACL_USER_OBJ 10002 /* User who owns the file. */
486#define ARCHIVE_ENTRY_ACL_GROUP 10003 /* Specified group. */
487#define ARCHIVE_ENTRY_ACL_GROUP_OBJ 10004 /* Group who owns the file. */
488#define ARCHIVE_ENTRY_ACL_MASK 10005 /* Modify group access (POSIX.1e only) */
489#define ARCHIVE_ENTRY_ACL_OTHER 10006 /* Public (POSIX.1e only) */
490#define ARCHIVE_ENTRY_ACL_EVERYONE 10107 /* Everyone (NFS4 only) */
491
492/*
493 * Set the ACL by clearing it and adding entries one at a time.
494 * Unlike the POSIX.1e ACL routines, you must specify the type
495 * (access/default) for each entry. Internally, the ACL data is just
496 * a soup of entries. API calls here allow you to retrieve just the
497 * entries of interest. This design (which goes against the spirit of
498 * POSIX.1e) is useful for handling archive formats that combine
499 * default and access information in a single ACL list.
500 */
501__LA_DECL void archive_entry_acl_clear(struct archive_entry *);
502__LA_DECL int archive_entry_acl_add_entry(struct archive_entry *,
503 int /* type */, int /* permset */, int /* tag */,
504 int /* qual */, const char * /* name */);
505__LA_DECL int archive_entry_acl_add_entry_w(struct archive_entry *,
506 int /* type */, int /* permset */, int /* tag */,
507 int /* qual */, const wchar_t * /* name */);
508
509/*
510 * To retrieve the ACL, first "reset", then repeatedly ask for the
511 * "next" entry. The want_type parameter allows you to request only
512 * certain types of entries.
513 */
514__LA_DECL int archive_entry_acl_reset(struct archive_entry *, int /* want_type */);
515__LA_DECL int archive_entry_acl_next(struct archive_entry *, int /* want_type */,
516 int * /* type */, int * /* permset */, int * /* tag */,
517 int * /* qual */, const char ** /* name */);
518__LA_DECL int archive_entry_acl_next_w(struct archive_entry *, int /* want_type */,
519 int * /* type */, int * /* permset */, int * /* tag */,
520 int * /* qual */, const wchar_t ** /* name */);
521
522/*
523 * Construct a text-format ACL. The flags argument is a bitmask that
524 * can include any of the following:
525 *
526 * Flags only for archive entries with POSIX.1e ACL:
527 * ARCHIVE_ENTRY_ACL_TYPE_ACCESS - Include POSIX.1e "access" entries.
528 * ARCHIVE_ENTRY_ACL_TYPE_DEFAULT - Include POSIX.1e "default" entries.
529 * ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT - Include "default:" before each
530 * default ACL entry.
531 * ARCHIVE_ENTRY_ACL_STYLE_SOLARIS - Output only one colon after "other" and
532 * "mask" entries.
533 *
534 * Flags only for archive entries with NFSv4 ACL:
535 * ARCHIVE_ENTRY_ACL_STYLE_COMPACT - Do not output the minus character for
536 * unset permissions and flags in NFSv4 ACL permission and flag fields
537 *
538 * Flags for for archive entries with POSIX.1e ACL or NFSv4 ACL:
539 * ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID - Include extra numeric ID field in
540 * each ACL entry.
541 * ARCHIVE_ENTRY_ACL_STYLE_SEPARATOR_COMMA - Separate entries with comma
542 * instead of newline.
543 */
544#define ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID 0x00000001
545#define ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT 0x00000002
546#define ARCHIVE_ENTRY_ACL_STYLE_SOLARIS 0x00000004
547#define ARCHIVE_ENTRY_ACL_STYLE_SEPARATOR_COMMA 0x00000008
548#define ARCHIVE_ENTRY_ACL_STYLE_COMPACT 0x00000010
549
550__LA_DECL wchar_t *archive_entry_acl_to_text_w(struct archive_entry *,
551 la_ssize_t * /* len */, int /* flags */);
552__LA_DECL char *archive_entry_acl_to_text(struct archive_entry *,
553 la_ssize_t * /* len */, int /* flags */);
554__LA_DECL int archive_entry_acl_from_text_w(struct archive_entry *,
555 const wchar_t * /* wtext */, int /* type */);
556__LA_DECL int archive_entry_acl_from_text(struct archive_entry *,
557 const char * /* text */, int /* type */);
558
559/* Deprecated constants */
560#define OLD_ARCHIVE_ENTRY_ACL_STYLE_EXTRA_ID 1024
561#define OLD_ARCHIVE_ENTRY_ACL_STYLE_MARK_DEFAULT 2048
562
563/* Deprecated functions */
564__LA_DECL const wchar_t *archive_entry_acl_text_w(struct archive_entry *,
565 int /* flags */) __LA_DEPRECATED;
566__LA_DECL const char *archive_entry_acl_text(struct archive_entry *,
567 int /* flags */) __LA_DEPRECATED;
568
569/* Return bitmask of ACL types in an archive entry */
570__LA_DECL int archive_entry_acl_types(struct archive_entry *);
571
572/* Return a count of entries matching 'want_type' */
573__LA_DECL int archive_entry_acl_count(struct archive_entry *, int /* want_type */);
574
575/* Return an opaque ACL object. */
576/* There's not yet anything clients can actually do with this... */
577struct archive_acl;
578__LA_DECL struct archive_acl *archive_entry_acl(struct archive_entry *);
579
580/*
581 * extended attributes
582 */
583
584__LA_DECL void archive_entry_xattr_clear(struct archive_entry *);
585__LA_DECL void archive_entry_xattr_add_entry(struct archive_entry *,
586 const char * /* name */, const void * /* value */,
587 size_t /* size */);
588
589/*
590 * To retrieve the xattr list, first "reset", then repeatedly ask for the
591 * "next" entry.
592 */
593
594__LA_DECL int archive_entry_xattr_count(struct archive_entry *);
595__LA_DECL int archive_entry_xattr_reset(struct archive_entry *);
596__LA_DECL int archive_entry_xattr_next(struct archive_entry *,
597 const char ** /* name */, const void ** /* value */, size_t *);
598
599/*
600 * sparse
601 */
602
603__LA_DECL void archive_entry_sparse_clear(struct archive_entry *);
604__LA_DECL void archive_entry_sparse_add_entry(struct archive_entry *,
605 la_int64_t /* offset */, la_int64_t /* length */);
606
607/*
608 * To retrieve the xattr list, first "reset", then repeatedly ask for the
609 * "next" entry.
610 */
611
612__LA_DECL int archive_entry_sparse_count(struct archive_entry *);
613__LA_DECL int archive_entry_sparse_reset(struct archive_entry *);
614__LA_DECL int archive_entry_sparse_next(struct archive_entry *,
615 la_int64_t * /* offset */, la_int64_t * /* length */);
616
617/*
618 * Utility to match up hardlinks.
619 *
620 * The 'struct archive_entry_linkresolver' is a cache of archive entries
621 * for files with multiple links. Here's how to use it:
622 * 1. Create a lookup object with archive_entry_linkresolver_new()
623 * 2. Tell it the archive format you're using.
624 * 3. Hand each archive_entry to archive_entry_linkify().
625 * That function will return 0, 1, or 2 entries that should
626 * be written.
627 * 4. Call archive_entry_linkify(resolver, NULL) until
628 * no more entries are returned.
629 * 5. Call archive_entry_linkresolver_free(resolver) to free resources.
630 *
631 * The entries returned have their hardlink and size fields updated
632 * appropriately. If an entry is passed in that does not refer to
633 * a file with multiple links, it is returned unchanged. The intention
634 * is that you should be able to simply filter all entries through
635 * this machine.
636 *
637 * To make things more efficient, be sure that each entry has a valid
638 * nlinks value. The hardlink cache uses this to track when all links
639 * have been found. If the nlinks value is zero, it will keep every
640 * name in the cache indefinitely, which can use a lot of memory.
641 *
642 * Note that archive_entry_size() is reset to zero if the file
643 * body should not be written to the archive. Pay attention!
644 */
645struct archive_entry_linkresolver;
646
647/*
648 * There are three different strategies for marking hardlinks.
649 * The descriptions below name them after the best-known
650 * formats that rely on each strategy:
651 *
652 * "Old cpio" is the simplest, it always returns any entry unmodified.
653 * As far as I know, only cpio formats use this. Old cpio archives
654 * store every link with the full body; the onus is on the dearchiver
655 * to detect and properly link the files as they are restored.
656 * "tar" is also pretty simple; it caches a copy the first time it sees
657 * any link. Subsequent appearances are modified to be hardlink
658 * references to the first one without any body. Used by all tar
659 * formats, although the newest tar formats permit the "old cpio" strategy
660 * as well. This strategy is very simple for the dearchiver,
661 * and reasonably straightforward for the archiver.
662 * "new cpio" is trickier. It stores the body only with the last
663 * occurrence. The complication is that we might not
664 * see every link to a particular file in a single session, so
665 * there's no easy way to know when we've seen the last occurrence.
666 * The solution here is to queue one link until we see the next.
667 * At the end of the session, you can enumerate any remaining
668 * entries by calling archive_entry_linkify(NULL) and store those
669 * bodies. If you have a file with three links l1, l2, and l3,
670 * you'll get the following behavior if you see all three links:
671 * linkify(l1) => NULL (the resolver stores l1 internally)
672 * linkify(l2) => l1 (resolver stores l2, you write l1)
673 * linkify(l3) => l2, l3 (all links seen, you can write both).
674 * If you only see l1 and l2, you'll get this behavior:
675 * linkify(l1) => NULL
676 * linkify(l2) => l1
677 * linkify(NULL) => l2 (at end, you retrieve remaining links)
678 * As the name suggests, this strategy is used by newer cpio variants.
679 * It's noticeably more complex for the archiver, slightly more complex
680 * for the dearchiver than the tar strategy, but makes it straightforward
681 * to restore a file using any link by simply continuing to scan until
682 * you see a link that is stored with a body. In contrast, the tar
683 * strategy requires you to rescan the archive from the beginning to
684 * correctly extract an arbitrary link.
685 */
686
687__LA_DECL struct archive_entry_linkresolver *archive_entry_linkresolver_new(void);
688__LA_DECL void archive_entry_linkresolver_set_strategy(
689 struct archive_entry_linkresolver *, int /* format_code */);
690__LA_DECL void archive_entry_linkresolver_free(struct archive_entry_linkresolver *);
691__LA_DECL void archive_entry_linkify(struct archive_entry_linkresolver *,
692 struct archive_entry **, struct archive_entry **);
693__LA_DECL struct archive_entry *archive_entry_partial_links(
694 struct archive_entry_linkresolver *res, unsigned int *links);
695
696#ifdef __cplusplus
697}
698#endif
699
700/* This is meaningless outside of this header. */
701#undef __LA_DECL
702
703#endif /* !ARCHIVE_ENTRY_H_INCLUDED */
704

Warning: That file was not part of the compilation database. It may have many parsing errors.