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