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