include/archive.h

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