1 /* vi: set sw=4 ts=4: */ 2 #ifndef UNARCHIVE_H 3 #define UNARCHIVE_H 1 4 5 PUSH_AND_SET_FUNCTION_VISIBILITY_TO_HIDDEN 6 7 enum { 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 31 typedef 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 46 struct hardlinks_t; 47 48 typedef 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 /* List of link placeholders */ 68 llist_t *link_placeholders; 69 70 /* Process the header component, e.g. tar -t */ 71 void FAST_FUNC (*action_header)(const file_header_t *); 72 73 /* Process the data component, e.g. extract to filesystem */ 74 void FAST_FUNC (*action_data)(struct archive_handle_t *); 75 76 /* Function that skips data */ 77 void FAST_FUNC (*seek)(int fd, off_t amount); 78 79 /* Count processed bytes */ 80 off_t offset; 81 82 /* Archiver specific. Can make it a union if it ever gets big */ 83 #if ENABLE_FEATURE_TAR_LONG_OPTIONS 84 unsigned tar__strip_components; 85 #endif 86 #define PAX_NEXT_FILE 0 87 #define PAX_GLOBAL 1 88 #if ENABLE_TAR || ENABLE_DPKG || ENABLE_DPKG_DEB 89 smallint tar__end; 90 # if ENABLE_FEATURE_TAR_GNU_EXTENSIONS 91 char* tar__longname; 92 char* tar__linkname; 93 # endif 94 # if ENABLE_FEATURE_TAR_TO_COMMAND 95 char* tar__to_command; 96 const char* tar__to_command_shell; 97 # endif 98 # if ENABLE_FEATURE_TAR_SELINUX 99 char* tar__sctx[2]; 100 # endif 101 #endif 102 #if ENABLE_CPIO || ENABLE_RPM2CPIO || ENABLE_RPM 103 uoff_t cpio__blocks; 104 struct bb_uidgid_t cpio__owner; 105 struct hardlinks_t *cpio__hardlinks_to_create; 106 struct hardlinks_t *cpio__created_hardlinks; 107 #endif 108 #if ENABLE_DPKG || ENABLE_DPKG_DEB 109 /* Temporary storage */ 110 char *dpkg__buffer; 111 /* How to process any sub archive, e.g. get_header_tar_gz */ 112 char FAST_FUNC (*dpkg__action_data_subarchive)(struct archive_handle_t *); 113 /* Contains the handle to a sub archive */ 114 struct archive_handle_t *dpkg__sub_archive; 115 #endif 116 #if ENABLE_FEATURE_AR_CREATE 117 const char *ar__name; 118 struct archive_handle_t *ar__out; 119 #endif 120 #if ENABLE_FEATURE_AR_LONG_FILENAMES 121 char *ar__long_names; 122 unsigned ar__long_name_size; 123 #endif 124 } archive_handle_t; 125 /* bits in ah_flags */ 126 #define ARCHIVE_RESTORE_DATE (1 << 0) 127 #define ARCHIVE_CREATE_LEADING_DIRS (1 << 1) 128 #define ARCHIVE_UNLINK_OLD (1 << 2) 129 #define ARCHIVE_EXTRACT_NEWER (1 << 3) 130 #define ARCHIVE_DONT_RESTORE_OWNER (1 << 4) 131 #define ARCHIVE_DONT_RESTORE_PERM (1 << 5) 132 #define ARCHIVE_NUMERIC_OWNER (1 << 6) 133 #define ARCHIVE_O_TRUNC (1 << 7) 134 #define ARCHIVE_REMEMBER_NAMES (1 << 8) 135 #if ENABLE_RPM 136 #define ARCHIVE_REPLACE_VIA_RENAME (1 << 9) 137 #endif 138 139 140 /* POSIX tar Header Block, from POSIX 1003.1-1990 */ 141 #define TAR_BLOCK_SIZE 512 142 #define NAME_SIZE 100 143 #define NAME_SIZE_STR "100" 144 typedef struct tar_header_t { /* byte offset */ 145 char name[NAME_SIZE]; /* 0-99 */ 146 char mode[8]; /* 100-107 */ 147 char uid[8]; /* 108-115 */ 148 char gid[8]; /* 116-123 */ 149 char size[12]; /* 124-135 */ 150 char mtime[12]; /* 136-147 */ 151 char chksum[8]; /* 148-155 */ 152 char typeflag; /* 156-156 */ 153 char linkname[NAME_SIZE]; /* 157-256 */ 154 /* POSIX: "ustar" NUL "00" */ 155 /* GNU tar: "ustar " NUL */ 156 /* Normally it's defined as magic[6] followed by 157 * version[2], but we put them together to save code. 158 */ 159 char magic[8]; /* 257-264 */ 160 char uname[32]; /* 265-296 */ 161 char gname[32]; /* 297-328 */ 162 char devmajor[8]; /* 329-336 */ 163 char devminor[8]; /* 337-344 */ 164 char prefix[155]; /* 345-499 */ 165 char padding[12]; /* 500-512 (pad to exactly TAR_BLOCK_SIZE) */ 166 } tar_header_t; 167 struct BUG_tar_header { 168 char c[sizeof(tar_header_t) == TAR_BLOCK_SIZE ? 1 : -1]; 169 }; 170 void chksum_and_xwrite_tar_header(int fd, struct tar_header_t *hp) FAST_FUNC; 171 172 173 extern const char cpio_TRAILER[]; 174 175 176 archive_handle_t *init_handle(void) FAST_FUNC; 177 178 char filter_accept_all(archive_handle_t *archive_handle) FAST_FUNC; 179 char filter_accept_list(archive_handle_t *archive_handle) FAST_FUNC; 180 char filter_accept_list_reassign(archive_handle_t *archive_handle) FAST_FUNC; 181 char filter_accept_reject_list(archive_handle_t *archive_handle) FAST_FUNC; 182 183 void unpack_ar_archive(archive_handle_t *ar_archive) FAST_FUNC; 184 185 void data_skip(archive_handle_t *archive_handle) FAST_FUNC; 186 void data_extract_all(archive_handle_t *archive_handle) FAST_FUNC; 187 void data_extract_to_stdout(archive_handle_t *archive_handle) FAST_FUNC; 188 void data_extract_to_command(archive_handle_t *archive_handle) FAST_FUNC; 189 190 void header_skip(const file_header_t *file_header) FAST_FUNC; 191 void header_list(const file_header_t *file_header) FAST_FUNC; 192 void header_verbose_list(const file_header_t *file_header) FAST_FUNC; 193 194 char get_header_ar(archive_handle_t *archive_handle) FAST_FUNC; 195 char get_header_cpio(archive_handle_t *archive_handle) FAST_FUNC; 196 char get_header_tar(archive_handle_t *archive_handle) FAST_FUNC; 197 char get_header_tar_gz(archive_handle_t *archive_handle) FAST_FUNC; 198 char get_header_tar_bz2(archive_handle_t *archive_handle) FAST_FUNC; 199 char get_header_tar_lzma(archive_handle_t *archive_handle) FAST_FUNC; 200 char get_header_tar_xz(archive_handle_t *archive_handle) FAST_FUNC; 201 202 void seek_by_jump(int fd, off_t amount) FAST_FUNC; 203 void seek_by_read(int fd, off_t amount) FAST_FUNC; 204 205 const char *strip_unsafe_prefix(const char *str) FAST_FUNC; 206 void create_or_remember_link(llist_t **link_placeholders, 207 const char *target, 208 const char *linkname, 209 int hard_link) FAST_FUNC; 210 void create_links_from_list(llist_t *list) FAST_FUNC; 211 212 void data_align(archive_handle_t *archive_handle, unsigned boundary) FAST_FUNC; 213 const llist_t *find_list_entry(const llist_t *list, const char *filename) FAST_FUNC; 214 const llist_t *find_list_entry2(const llist_t *list, const char *filename) FAST_FUNC; 215 216 /* A bit of bunzip2 internals are exposed for compressed help support: */ 217 char *unpack_bz2_data(const char *packed, int packed_len, int unpacked_len) FAST_FUNC; 218 219 /* Meaning and direction (input/output) of the fields are transformer-specific */ 220 typedef struct transformer_state_t { 221 smallint signature_skipped; /* most often referenced member */ 222 223 IF_DESKTOP(long long) int FAST_FUNC (*xformer)(struct transformer_state_t *xstate); 224 USE_FOR_NOMMU(const char *xformer_prog;) 225 226 /* Source */ 227 int src_fd; 228 /* Output */ 229 int dst_fd; 230 size_t mem_output_size_max; /* if non-zero, decompress to RAM instead of fd */ 231 size_t mem_output_size; 232 char *mem_output_buf; 233 234 off_t bytes_out; 235 off_t bytes_in; /* used in unzip code only: needs to know packed size */ 236 uint32_t crc32; 237 time_t mtime; /* gunzip code may set this on exit */ 238 239 union { /* if we read magic, it's saved here */ 240 uint8_t b[8]; 241 uint16_t b16[4]; 242 uint32_t b32[2]; 243 } magic; 244 } transformer_state_t; 245 246 void init_transformer_state(transformer_state_t *xstate) FAST_FUNC; 247 ssize_t transformer_write(transformer_state_t *xstate, const void *buf, size_t bufsize) FAST_FUNC; 248 ssize_t xtransformer_write(transformer_state_t *xstate, const void *buf, size_t bufsize) FAST_FUNC; 249 int check_signature16(transformer_state_t *xstate, unsigned magic16) FAST_FUNC; 250 251 IF_DESKTOP(long long) int inflate_unzip(transformer_state_t *xstate) FAST_FUNC; 252 IF_DESKTOP(long long) int unpack_Z_stream(transformer_state_t *xstate) FAST_FUNC; 253 IF_DESKTOP(long long) int unpack_gz_stream(transformer_state_t *xstate) FAST_FUNC; 254 IF_DESKTOP(long long) int unpack_bz2_stream(transformer_state_t *xstate) FAST_FUNC; 255 IF_DESKTOP(long long) int unpack_lzma_stream(transformer_state_t *xstate) FAST_FUNC; 256 IF_DESKTOP(long long) int unpack_xz_stream(transformer_state_t *xstate) FAST_FUNC; 257 258 char* append_ext(char *filename, const char *expected_ext) FAST_FUNC; 259 int bbunpack(char **argv, 260 IF_DESKTOP(long long) int FAST_FUNC (*unpacker)(transformer_state_t *xstate), 261 char* FAST_FUNC (*make_new_name)(char *filename, const char *expected_ext), 262 const char *expected_ext 263 ) FAST_FUNC; 264 #define BBUNPK_OPTSTR "cfkvq" 265 #define BBUNPK_OPTSTRLEN 5 266 #define BBUNPK_OPTSTRMASK ((1 << BBUNPK_OPTSTRLEN) - 1) 267 enum { 268 BBUNPK_OPT_STDOUT = 1 << 0, 269 BBUNPK_OPT_FORCE = 1 << 1, 270 /* only some decompressors: */ 271 BBUNPK_OPT_KEEP = 1 << 2, 272 BBUNPK_OPT_VERBOSE = 1 << 3, 273 BBUNPK_OPT_QUIET = 1 << 4, 274 /* not included in BBUNPK_OPTSTR: */ 275 BBUNPK_OPT_DECOMPRESS = 1 << 5, 276 BBUNPK_OPT_TEST = 1 << 6, 277 BBUNPK_SEAMLESS_MAGIC = (1 << 31) * ENABLE_ZCAT * SEAMLESS_COMPRESSION, 278 }; 279 280 void check_errors_in_children(int signo); 281 #if BB_MMU 282 void fork_transformer(int fd, 283 int signature_skipped, 284 IF_DESKTOP(long long) int FAST_FUNC (*transformer)(transformer_state_t *xstate) 285 ) FAST_FUNC; 286 #define fork_transformer_with_sig(fd, transformer, transform_prog) fork_transformer((fd), 0, (transformer)) 287 #define fork_transformer_with_no_sig(fd, transformer) fork_transformer((fd), 1, (transformer)) 288 #else 289 void fork_transformer(int fd, const char *transform_prog) FAST_FUNC; 290 #define fork_transformer_with_sig(fd, transformer, transform_prog) fork_transformer((fd), (transform_prog)) 291 /* fork_transformer_with_no_sig() does not exist on NOMMU */ 292 #endif 293 294 295 POP_SAVED_FUNCTION_VISIBILITY 296 297 #endif 298