summaryrefslogtreecommitdiff
path: root/include/bb_archive.h (plain)
blob: fc976f217ba03377494d8ee5c08b3f2c69fab02f
1/* vi: set sw=4 ts=4: */
2#ifndef UNARCHIVE_H
3#define UNARCHIVE_H 1
4
5PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN
6
7enum {
8#if BB_BIG_ENDIAN
9 COMPRESS_MAGIC = 0x1f9d,
10 GZIP_MAGIC = 0x1f8b,
11 BZIP2_MAGIC = 256 * 'B' + 'Z',
12 /* .xz signature: 0xfd, '7', 'z', 'X', 'Z', 0x00 */
13 /* More info at: http://tukaani.org/xz/xz-file-format.txt */
14 XZ_MAGIC1 = 256 * 0xfd + '7',
15 XZ_MAGIC2 = 256 * (unsigned)(256 * (256 * 'z' + 'X') + 'Z') + 0,
16 /* Different form: 32 bits, then 16 bits: */
17 /* (unsigned) cast suppresses "integer overflow in expression" warning */
18 XZ_MAGIC1a = 256 * (unsigned)(256 * (256 * 0xfd + '7') + 'z') + 'X',
19 XZ_MAGIC2a = 256 * 'Z' + 0,
20#else
21 COMPRESS_MAGIC = 0x9d1f,
22 GZIP_MAGIC = 0x8b1f,
23 BZIP2_MAGIC = 'B' + 'Z' * 256,
24 XZ_MAGIC1 = 0xfd + '7' * 256,
25 XZ_MAGIC2 = 'z' + ('X' + ('Z' + 0 * 256) * 256) * 256,
26 XZ_MAGIC1a = 0xfd + ('7' + ('z' + 'X' * 256) * 256) * 256,
27 XZ_MAGIC2a = 'Z' + 0 * 256,
28#endif
29};
30
31typedef struct file_header_t {
32 char *name;
33 char *link_target;
34#if ENABLE_FEATURE_TAR_UNAME_GNAME
35 char *tar__uname;
36 char *tar__gname;
37#endif
38 off_t size;
39 uid_t uid;
40 gid_t gid;
41 mode_t mode;
42 time_t mtime;
43 dev_t device;
44} file_header_t;
45
46struct hardlinks_t;
47
48typedef struct archive_handle_t {
49 /* Flags. 1st since it is most used member */
50 unsigned ah_flags;
51
52 /* The raw stream as read from disk or stdin */
53 int src_fd;
54
55 /* Define if the header and data component should be processed */
56 char FAST_FUNC (*filter)(struct archive_handle_t *);
57 /* List of files that have been accepted */
58 llist_t *accept;
59 /* List of files that have been rejected */
60 llist_t *reject;
61 /* List of files that have successfully been worked on */
62 llist_t *passed;
63
64 /* Currently processed file's header */
65 file_header_t *file_header;
66
67 /* Process the header component, e.g. tar -t */
68 void FAST_FUNC (*action_header)(const file_header_t *);
69
70 /* Process the data component, e.g. extract to filesystem */
71 void FAST_FUNC (*action_data)(struct archive_handle_t *);
72
73 /* Function that skips data */
74 void FAST_FUNC (*seek)(int fd, off_t amount);
75
76 /* Count processed bytes */
77 off_t offset;
78
79 /* Archiver specific. Can make it a union if it ever gets big */
80#define PAX_NEXT_FILE 0
81#define PAX_GLOBAL 1
82#if ENABLE_TAR || ENABLE_DPKG || ENABLE_DPKG_DEB
83 smallint tar__end;
84# if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
85 char* tar__longname;
86 char* tar__linkname;
87# endif
88# if ENABLE_FEATURE_TAR_TO_COMMAND
89 char* tar__to_command;
90 const char* tar__to_command_shell;
91# endif
92# if ENABLE_FEATURE_TAR_SELINUX
93 char* tar__sctx[2];
94# endif
95#endif
96#if ENABLE_CPIO || ENABLE_RPM2CPIO || ENABLE_RPM
97 uoff_t cpio__blocks;
98 struct hardlinks_t *cpio__hardlinks_to_create;
99 struct hardlinks_t *cpio__created_hardlinks;
100#endif
101#if ENABLE_DPKG || ENABLE_DPKG_DEB
102 /* Temporary storage */
103 char *dpkg__buffer;
104 /* How to process any sub archive, e.g. get_header_tar_gz */
105 char FAST_FUNC (*dpkg__action_data_subarchive)(struct archive_handle_t *);
106 /* Contains the handle to a sub archive */
107 struct archive_handle_t *dpkg__sub_archive;
108#endif
109#if ENABLE_FEATURE_AR_CREATE
110 const char *ar__name;
111 struct archive_handle_t *ar__out;
112#endif
113} archive_handle_t;
114/* bits in ah_flags */
115#define ARCHIVE_RESTORE_DATE (1 << 0)
116#define ARCHIVE_CREATE_LEADING_DIRS (1 << 1)
117#define ARCHIVE_UNLINK_OLD (1 << 2)
118#define ARCHIVE_EXTRACT_QUIET (1 << 3)
119#define ARCHIVE_EXTRACT_NEWER (1 << 4)
120#define ARCHIVE_DONT_RESTORE_OWNER (1 << 5)
121#define ARCHIVE_DONT_RESTORE_PERM (1 << 6)
122#define ARCHIVE_NUMERIC_OWNER (1 << 7)
123#define ARCHIVE_O_TRUNC (1 << 8)
124#define ARCHIVE_REMEMBER_NAMES (1 << 9)
125#if ENABLE_RPM
126#define ARCHIVE_REPLACE_VIA_RENAME (1 << 10)
127#endif
128#if ENABLE_FEATURE_TAR_SELINUX
129#define ARCHIVE_STORE_SELINUX (1 << 15)
130#endif
131
132
133/* POSIX tar Header Block, from POSIX 1003.1-1990 */
134#define TAR_BLOCK_SIZE 512
135#define NAME_SIZE 100
136#define NAME_SIZE_STR "100"
137typedef struct tar_header_t { /* byte offset */
138 char name[NAME_SIZE]; /* 0-99 */
139 char mode[8]; /* 100-107 */
140 char uid[8]; /* 108-115 */
141 char gid[8]; /* 116-123 */
142 char size[12]; /* 124-135 */
143 char mtime[12]; /* 136-147 */
144 char chksum[8]; /* 148-155 */
145 char typeflag; /* 156-156 */
146 char linkname[NAME_SIZE]; /* 157-256 */
147 /* POSIX: "ustar" NUL "00" */
148 /* GNU tar: "ustar " NUL */
149 /* Normally it's defined as magic[6] followed by
150 * version[2], but we put them together to save code.
151 */
152 char magic[8]; /* 257-264 (magic 6 + version 2) */
153 char uname[32]; /* 265-296 */
154 char gname[32]; /* 297-328 */
155 char devmajor[8]; /* 329-336 */
156 char devminor[8]; /* 337-344 */
157 char prefix[155]; /* 345-499 */
158 char padding[12]; /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */
159} tar_header_t;
160struct BUG_tar_header {
161 char c[sizeof(tar_header_t) == TAR_BLOCK_SIZE ? 1 : -1];
162};
163
164
165
166archive_handle_t *init_handle(void) FAST_FUNC;
167
168char filter_accept_all(archive_handle_t *archive_handle) FAST_FUNC;
169char filter_accept_list(archive_handle_t *archive_handle) FAST_FUNC;
170char filter_accept_list_reassign(archive_handle_t *archive_handle) FAST_FUNC;
171char filter_accept_reject_list(archive_handle_t *archive_handle) FAST_FUNC;
172
173void unpack_ar_archive(archive_handle_t *ar_archive) FAST_FUNC;
174
175void data_skip(archive_handle_t *archive_handle) FAST_FUNC;
176void data_extract_all(archive_handle_t *archive_handle) FAST_FUNC;
177void data_extract_to_stdout(archive_handle_t *archive_handle) FAST_FUNC;
178void data_extract_to_command(archive_handle_t *archive_handle) FAST_FUNC;
179
180void header_skip(const file_header_t *file_header) FAST_FUNC;
181void header_list(const file_header_t *file_header) FAST_FUNC;
182void header_verbose_list(const file_header_t *file_header) FAST_FUNC;
183
184char get_header_ar(archive_handle_t *archive_handle) FAST_FUNC;
185char get_header_cpio(archive_handle_t *archive_handle) FAST_FUNC;
186char get_header_tar(archive_handle_t *archive_handle) FAST_FUNC;
187char get_header_tar_gz(archive_handle_t *archive_handle) FAST_FUNC;
188char get_header_tar_bz2(archive_handle_t *archive_handle) FAST_FUNC;
189char get_header_tar_lzma(archive_handle_t *archive_handle) FAST_FUNC;
190
191void seek_by_jump(int fd, off_t amount) FAST_FUNC;
192void seek_by_read(int fd, off_t amount) FAST_FUNC;
193
194const char *strip_unsafe_prefix(const char *str) FAST_FUNC;
195
196void data_align(archive_handle_t *archive_handle, unsigned boundary) FAST_FUNC;
197const llist_t *find_list_entry(const llist_t *list, const char *filename) FAST_FUNC;
198const llist_t *find_list_entry2(const llist_t *list, const char *filename) FAST_FUNC;
199
200/* A bit of bunzip2 internals are exposed for compressed help support: */
201typedef struct bunzip_data bunzip_data;
202int start_bunzip(bunzip_data **bdp, int in_fd, const void *inbuf, int len) FAST_FUNC;
203/* NB: read_bunzip returns < 0 on error, or the number of *unfilled* bytes
204 * in outbuf. IOW: on EOF returns len ("all bytes are not filled"), not 0: */
205int read_bunzip(bunzip_data *bd, char *outbuf, int len) FAST_FUNC;
206void dealloc_bunzip(bunzip_data *bd) FAST_FUNC;
207
208/* Meaning and direction (input/output) of the fields are transformer-specific */
209typedef struct transformer_aux_data_t {
210 smallint check_signature; /* most often referenced member */
211 off_t bytes_out;
212 off_t bytes_in; /* used in unzip code only: needs to know packed size */
213 uint32_t crc32;
214 time_t mtime; /* gunzip code may set this on exit */
215} transformer_aux_data_t;
216
217void init_transformer_aux_data(transformer_aux_data_t *aux) FAST_FUNC;
218int FAST_FUNC check_signature16(transformer_aux_data_t *aux, int src_fd, unsigned magic16) FAST_FUNC;
219
220IF_DESKTOP(long long) int inflate_unzip(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
221IF_DESKTOP(long long) int unpack_Z_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
222IF_DESKTOP(long long) int unpack_gz_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
223IF_DESKTOP(long long) int unpack_bz2_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
224IF_DESKTOP(long long) int unpack_lzma_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
225IF_DESKTOP(long long) int unpack_xz_stream(transformer_aux_data_t *aux, int src_fd, int dst_fd) FAST_FUNC;
226
227char* append_ext(char *filename, const char *expected_ext) FAST_FUNC;
228int bbunpack(char **argv,
229 IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(transformer_aux_data_t *aux),
230 char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext),
231 const char *expected_ext
232) FAST_FUNC;
233
234void check_errors_in_children(int signo);
235#if BB_MMU
236void open_transformer(int fd,
237 int check_signature,
238 IF_DESKTOP(long long) int FAST_FUNC (*transformer)(transformer_aux_data_t *aux, int src_fd, int dst_fd)
239) FAST_FUNC;
240#define open_transformer_with_sig(fd, transformer, transform_prog) open_transformer((fd), 1, (transformer))
241#define open_transformer_with_no_sig(fd, transformer) open_transformer((fd), 0, (transformer))
242#else
243void open_transformer(int fd, const char *transform_prog) FAST_FUNC;
244#define open_transformer_with_sig(fd, transformer, transform_prog) open_transformer((fd), (transform_prog))
245/* open_transformer_with_no_sig() does not exist on NOMMU */
246#endif
247
248
249POP_SAVED_FUNCTION_VISIBILITY
250
251#endif
252
generated by cgit at 2024-05-16 02:19:03 (GMT)