blob: 8013e614ee5f3ce9ca13aaa585a3d51762cc79f3 [file] [log] [blame]
bigbiff bigbiff9c754052013-01-09 09:09:08 -05001/*
2** Copyright 1998-2003 University of Illinois Board of Trustees
3** Copyright 1998-2003 Mark D. Roth
4** All rights reserved.
5**
6** libtar.h - header file for libtar library
7**
8** Mark D. Roth <roth@uiuc.edu>
9** Campus Information Technologies and Educational Services
10** University of Illinois at Urbana-Champaign
11*/
12
13#ifndef LIBTAR_H
14#define LIBTAR_H
15
16#include <sys/types.h>
17#include <sys/stat.h>
Ethan Yonker71187742017-01-13 13:30:10 -060018#include <linux/capability.h>
bigbiff bigbiff9c754052013-01-09 09:09:08 -050019#include "tar.h"
20
21#include "libtar_listhash.h"
22
bigbiff7ba75002020-04-11 20:47:09 -040023#ifdef USE_FSCRYPT
24#include "fscrypt_policy.h"
25#endif
26
bigbiff bigbiff9c754052013-01-09 09:09:08 -050027#ifdef __cplusplus
28extern "C"
29{
30#endif
31
32
33/* useful constants */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -050034/* see FIXME note in block.c regarding T_BLOCKSIZE */
bigbiff bigbiff9c754052013-01-09 09:09:08 -050035#define T_BLOCKSIZE 512
36#define T_NAMELEN 100
37#define T_PREFIXLEN 155
38#define T_MAXPATHLEN (T_NAMELEN + T_PREFIXLEN)
39
40/* GNU extensions for typeflag */
41#define GNU_LONGNAME_TYPE 'L'
42#define GNU_LONGLINK_TYPE 'K'
43
Vojtech Bocek25fd68d2013-08-27 03:10:10 +020044/* extended metadata for next file - used to store selinux_context */
45#define TH_EXT_TYPE 'x'
Ethan Yonker71187742017-01-13 13:30:10 -060046#define TH_POL_TYPE_DO_NOT_USE 'p'
Vojtech Bocek25fd68d2013-08-27 03:10:10 +020047
Mohd Faraz15247642023-01-16 16:16:21 +010048#define LOG(...) printf("libtar: " __VA_ARGS__)
49
bigbiff bigbiff9c754052013-01-09 09:09:08 -050050/* our version of the tar header structure */
51struct tar_header
52{
53 char name[100];
54 char mode[8];
55 char uid[8];
56 char gid[8];
57 char size[12];
58 char mtime[12];
59 char chksum[8];
60 char typeflag;
61 char linkname[100];
62 char magic[6];
63 char version[2];
64 char uname[32];
65 char gname[32];
66 char devmajor[8];
67 char devminor[8];
68 char prefix[155];
69 char padding[12];
70 char *gnu_longname;
71 char *gnu_longlink;
Vojtech Bocek25fd68d2013-08-27 03:10:10 +020072 char *selinux_context;
bigbiff7ba75002020-04-11 20:47:09 -040073#ifdef USE_FSCRYPT
bigbiffa957f072021-03-07 18:20:29 -050074#ifdef USE_FSCRYPT_POLICY_V1
75 struct fscrypt_policy_v1 *fep;
76#else
77 struct fscrypt_policy_v2 *fep;
78#endif
bigbiff7ba75002020-04-11 20:47:09 -040079#endif
Ethan Yonker71187742017-01-13 13:30:10 -060080 int has_cap_data;
81 struct vfs_cap_data cap_data;
Ethan Yonker8d039f72017-02-03 14:26:15 -060082 int has_user_default;
83 int has_user_cache;
84 int has_user_code_cache;
bigbiff bigbiff9c754052013-01-09 09:09:08 -050085};
86
87
88/***** handle.c ************************************************************/
89
90typedef int (*openfunc_t)(const char *, int, ...);
91typedef int (*closefunc_t)(int);
92typedef ssize_t (*readfunc_t)(int, void *, size_t);
93typedef ssize_t (*writefunc_t)(int, const void *, size_t);
94
95typedef struct
96{
97 openfunc_t openfunc;
98 closefunc_t closefunc;
99 readfunc_t readfunc;
100 writefunc_t writefunc;
101}
102tartype_t;
103
104typedef struct
105{
106 tartype_t *type;
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500107 const char *pathname;
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500108 long fd;
109 int oflags;
110 int options;
111 struct tar_header th_buf;
112 libtar_hash_t *h;
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500113
114 /* introduced in libtar 1.2.21 */
115 char *th_pathname;
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500116}
117TAR;
118
119/* constant values for the TAR options field */
120#define TAR_GNU 1 /* use GNU extensions */
121#define TAR_VERBOSE 2 /* output file info to stdout */
122#define TAR_NOOVERWRITE 4 /* don't overwrite existing files */
123#define TAR_IGNORE_EOT 8 /* ignore double zero blocks as EOF */
124#define TAR_CHECK_MAGIC 16 /* check magic in file header */
125#define TAR_CHECK_VERSION 32 /* check version in file header */
126#define TAR_IGNORE_CRC 64 /* ignore CRC in file header */
Vojtech Bocek25fd68d2013-08-27 03:10:10 +0200127#define TAR_STORE_SELINUX 128 /* store selinux context */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500128#define TAR_USE_NUMERIC_ID 256 /* favor numeric owner over names */
bigbiffa957f072021-03-07 18:20:29 -0500129
bigbiff7ba75002020-04-11 20:47:09 -0400130#ifdef USE_FSCRYPT
131#define TAR_STORE_FSCRYPT_POL 512 /* store fscrypt crypto policy */
132#endif
bigbiffa957f072021-03-07 18:20:29 -0500133
Ethan Yonker71187742017-01-13 13:30:10 -0600134#define TAR_STORE_POSIX_CAP 1024 /* store posix file capabilities */
Ethan Yonker8d039f72017-02-03 14:26:15 -0600135#define TAR_STORE_ANDROID_USER_XATTR 2048 /* store android user.* xattr */
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500136
137/* this is obsolete - it's here for backwards-compatibility only */
138#define TAR_IGNORE_MAGIC 0
139
140extern const char libtar_version[];
141
142
143/* open a new tarfile handle */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500144int tar_open(TAR **t, const char *pathname, tartype_t *type,
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500145 int oflags, int mode, int options);
146
147/* make a tarfile handle out of a previously-opened descriptor */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500148int tar_fdopen(TAR **t, int fd, const char *pathname, tartype_t *type,
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500149 int oflags, int mode, int options);
150
151/* returns the descriptor associated with t */
152int tar_fd(TAR *t);
153
154/* close tarfile handle */
155int tar_close(TAR *t);
156
157
158/***** append.c ************************************************************/
159
160/* forward declaration to appease the compiler */
161struct tar_dev;
162
163/* cleanup function */
164void tar_dev_free(struct tar_dev *tdp);
165
166/* Appends a file to the tar archive.
167 * Arguments:
168 * t = TAR handle to append to
169 * realname = path of file to append
170 * savename = name to save the file under in the archive
171 */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500172int tar_append_file(TAR *t, const char *realname, const char *savename);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500173
174/* write EOF indicator */
175int tar_append_eof(TAR *t);
176
177/* add file contents to a tarchive */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500178int tar_append_regfile(TAR *t, const char *realname);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500179
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500180/* Appends in-memory file contents to a tarchive.
181 * Arguments:
182 * t = TAR handle to append to
183 * savename = name to save the file under in the archive
184 * mode = mode
185 * uid, gid = owner
186 * buf, len = in-memory buffer
187 */
188int tar_append_file_contents(TAR *t, const char *savename, mode_t mode,
189 uid_t uid, gid_t gid, void *buf, size_t len);
190
191/* add buffer to a tarchive */
192int tar_append_buffer(TAR *t, void *buf, size_t len);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500193
194/***** block.c *************************************************************/
195
196/* macros for reading/writing tarchive blocks */
197#define tar_block_read(t, buf) \
198 (*((t)->type->readfunc))((t)->fd, (char *)(buf), T_BLOCKSIZE)
199#define tar_block_write(t, buf) \
200 (*((t)->type->writefunc))((t)->fd, (char *)(buf), T_BLOCKSIZE)
201
202/* read/write a header block */
203int th_read(TAR *t);
204int th_write(TAR *t);
205
206
207/***** decode.c ************************************************************/
208
209/* determine file type */
210#define TH_ISREG(t) ((t)->th_buf.typeflag == REGTYPE \
211 || (t)->th_buf.typeflag == AREGTYPE \
212 || (t)->th_buf.typeflag == CONTTYPE \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500213 || (S_ISREG((mode_t)oct_to_int((t)->th_buf.mode, sizeof((t)->th_buf.mode))) \
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500214 && (t)->th_buf.typeflag != LNKTYPE))
215#define TH_ISLNK(t) ((t)->th_buf.typeflag == LNKTYPE)
216#define TH_ISSYM(t) ((t)->th_buf.typeflag == SYMTYPE \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500217 || S_ISLNK((mode_t)oct_to_int((t)->th_buf.mode, sizeof((t)->th_buf.mode))))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500218#define TH_ISCHR(t) ((t)->th_buf.typeflag == CHRTYPE \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500219 || S_ISCHR((mode_t)oct_to_int((t)->th_buf.mode, sizeof((t)->th_buf.mode))))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500220#define TH_ISBLK(t) ((t)->th_buf.typeflag == BLKTYPE \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500221 || S_ISBLK((mode_t)oct_to_int((t)->th_buf.mode, sizeof((t)->th_buf.mode))))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500222#define TH_ISDIR(t) ((t)->th_buf.typeflag == DIRTYPE \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500223 || S_ISDIR((mode_t)oct_to_int((t)->th_buf.mode, sizeof((t)->th_buf.mode))) \
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500224 || ((t)->th_buf.typeflag == AREGTYPE \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500225 && strnlen((t)->th_buf.name, T_NAMELEN) \
226 && ((t)->th_buf.name[strnlen((t)->th_buf.name, T_NAMELEN) - 1] == '/')))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500227#define TH_ISFIFO(t) ((t)->th_buf.typeflag == FIFOTYPE \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500228 || S_ISFIFO((mode_t)oct_to_int((t)->th_buf.mode, sizeof((t)->th_buf.mode))))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500229#define TH_ISLONGNAME(t) ((t)->th_buf.typeflag == GNU_LONGNAME_TYPE)
230#define TH_ISLONGLINK(t) ((t)->th_buf.typeflag == GNU_LONGLINK_TYPE)
Vojtech Bocek25fd68d2013-08-27 03:10:10 +0200231#define TH_ISEXTHEADER(t) ((t)->th_buf.typeflag == TH_EXT_TYPE)
Ethan Yonker71187742017-01-13 13:30:10 -0600232#define TH_ISPOLHEADER(t) ((t)->th_buf.typeflag == TH_POL_TYPE_DO_NOT_USE)
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500233
234/* decode tar header info */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500235#define th_get_crc(t) oct_to_int((t)->th_buf.chksum, sizeof((t)->th_buf.chksum))
236#define th_get_size(t) oct_to_int_ex((t)->th_buf.size, sizeof((t)->th_buf.size))
237#define th_get_mtime(t) oct_to_int_ex((t)->th_buf.mtime, sizeof((t)->th_buf.mtime))
238#define th_get_devmajor(t) oct_to_int((t)->th_buf.devmajor, sizeof((t)->th_buf.devmajor))
239#define th_get_devminor(t) oct_to_int((t)->th_buf.devminor, sizeof((t)->th_buf.devminor))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500240#define th_get_linkname(t) ((t)->th_buf.gnu_longlink \
241 ? (t)->th_buf.gnu_longlink \
242 : (t)->th_buf.linkname)
243char *th_get_pathname(TAR *t);
244mode_t th_get_mode(TAR *t);
245uid_t th_get_uid(TAR *t);
246gid_t th_get_gid(TAR *t);
247
248
249/***** encode.c ************************************************************/
250
251/* encode file info in th_header */
252void th_set_type(TAR *t, mode_t mode);
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500253void th_set_path(TAR *t, const char *pathname);
254void th_set_link(TAR *t, const char *linkname);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500255void th_set_device(TAR *t, dev_t device);
256void th_set_user(TAR *t, uid_t uid);
257void th_set_group(TAR *t, gid_t gid);
258void th_set_mode(TAR *t, mode_t fmode);
259#define th_set_mtime(t, fmtime) \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500260 int_to_oct_ex((fmtime), (t)->th_buf.mtime, sizeof((t)->th_buf.mtime))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500261#define th_set_size(t, fsize) \
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500262 int_to_oct_ex((fsize), (t)->th_buf.size, sizeof((t)->th_buf.size))
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500263
264/* encode everything at once (except the pathname and linkname) */
265void th_set_from_stat(TAR *t, struct stat *s);
266
267/* encode magic, version, and crc - must be done after everything else is set */
268void th_finish(TAR *t);
269
270
271/***** extract.c ***********************************************************/
272
273/* sequentially extract next file from t */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500274int tar_extract_file(TAR *t, const char *realname, const char *prefix, const int *progress_fd);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500275
276/* extract different file types */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500277int tar_extract_dir(TAR *t, const char *realname);
278int tar_extract_hardlink(TAR *t, const char *realname, const char *prefix);
279int tar_extract_symlink(TAR *t, const char *realname);
280int tar_extract_chardev(TAR *t, const char *realname);
281int tar_extract_blockdev(TAR *t, const char *realname);
282int tar_extract_fifo(TAR *t, const char *realname);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500283
284/* for regfiles, we need to extract the content blocks as well */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500285int tar_extract_regfile(TAR *t, const char *realname, const int *progress_fd);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500286int tar_skip_regfile(TAR *t);
287
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500288/* extract regfile to buffer */
289int tar_extract_file_contents(TAR *t, void *buf, size_t *lenp);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500290
291/***** output.c ************************************************************/
292
293/* print the tar header */
294void th_print(TAR *t);
295
296/* print "ls -l"-like output for the file described by th */
297void th_print_long_ls(TAR *t);
298
299
300/***** util.c *************************************************************/
301
302/* hashing function for pathnames */
303int path_hashfunc(char *key, int numbuckets);
304
305/* matching function for dev_t's */
306int dev_match(dev_t *dev1, dev_t *dev2);
307
308/* matching function for ino_t's */
309int ino_match(ino_t *ino1, ino_t *ino2);
310
311/* hashing function for dev_t's */
312int dev_hash(dev_t *dev);
313
314/* hashing function for ino_t's */
315int ino_hash(ino_t *inode);
316
317/* create any necessary dirs */
318int mkdirhier(char *path);
319
320/* calculate header checksum */
321int th_crc_calc(TAR *t);
322
323/* calculate a signed header checksum */
324int th_signed_crc_calc(TAR *t);
325
326/* compare checksums in a forgiving way */
327#define th_crc_ok(t) (th_get_crc(t) == th_crc_calc(t) || th_get_crc(t) == th_signed_crc_calc(t))
328
329/* string-octal to integer conversion */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500330int64_t oct_to_int(char *oct, size_t len);
331
332/* string-octal or binary to integer conversion */
333int64_t oct_to_int_ex(char *oct, size_t len);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500334
335/* integer to NULL-terminated string-octal conversion */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500336void int_to_oct(int64_t num, char *oct, size_t octlen);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500337
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500338/* integer to string-octal conversion, or binary as necessary */
339void int_to_oct_ex(int64_t num, char *oct, size_t octlen);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500340
Ethan Yonker71187742017-01-13 13:30:10 -0600341/* prints posix file capabilities */
342void print_caps(struct vfs_cap_data *cap_data);
343
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500344
345/***** wrapper.c **********************************************************/
346
347/* extract groups of files */
348int tar_extract_glob(TAR *t, char *globname, char *prefix);
Ethan Yonker1b7a31b2014-07-03 15:09:22 -0500349int tar_extract_all(TAR *t, char *prefix, const int *progress_fd);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500350
351/* add a whole tree of files */
James Christopher Adduono6f57f7c2016-03-01 16:01:53 -0500352int tar_append_tree(TAR *t, char *realdir, char *savedir);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500353
n0d33b511632013-03-06 21:14:15 +0200354/* find an entry */
355int tar_find(TAR *t, char *searchstr);
bigbiff bigbiff9c754052013-01-09 09:09:08 -0500356
357#ifdef __cplusplus
358}
359#endif
360
361#endif /* ! LIBTAR_H */
362