2 * Copyright (c) 2018 Grzegorz Antoniak (http://antoniak.org)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include "archive_platform.h"
33 #include <zlib.h> /* crc32 */
38 #include "archive_crc32.h"
41 #include "archive_entry.h"
42 #include "archive_entry_locale.h"
43 #include "archive_ppmd7_private.h"
44 #include "archive_entry_private.h"
49 #include "archive_blake2.h"
52 /*#define CHECK_CRC_ON_SOLID_SKIP*/
53 /*#define DONT_FAIL_ON_CRC_ERROR*/
56 #define rar5_min(a, b) (((a) > (b)) ? (b) : (a))
57 #define rar5_max(a, b) (((a) > (b)) ? (a) : (b))
58 #define rar5_countof(X) ((const ssize_t) (sizeof(X) / sizeof(*X)))
61 #define DEBUG_CODE if(1)
63 #define DEBUG_CODE if(0)
66 /* Real RAR5 magic number is:
68 * 0x52, 0x61, 0x72, 0x21, 0x1a, 0x07, 0x01, 0x00
71 * It's stored in `rar5_signature` after XOR'ing it with 0xA1, because I don't
72 * want to put this magic sequence in each binary that uses libarchive, so
73 * applications that scan through the file for this marker won't trigger on
76 * The array itself is decrypted in `rar5_init` function. */
78 static unsigned char rar5_signature[] = { 243, 192, 211, 128, 187, 166, 160, 161 };
79 static const ssize_t rar5_signature_size = sizeof(rar5_signature);
80 /* static const size_t g_unpack_buf_chunk_size = 1024; */
81 static const size_t g_unpack_window_size = 0x20000;
84 ssize_t bytes_remaining;
85 ssize_t unpacked_size;
86 int64_t last_offset; /* Used in sanity checks. */
87 int64_t last_size; /* Used in sanity checks. */
89 uint8_t solid : 1; /* Is this a solid stream? */
90 uint8_t service : 1; /* Is this file a service data? */
92 /* Optional time fields. */
98 /* Optional hash fields. */
99 uint32_t stored_crc32;
100 uint32_t calculated_crc32;
101 uint8_t blake2sp[32];
102 blake2sp_state b2state;
107 FILTER_DELTA = 0, /* Generic pattern. */
108 FILTER_E8 = 1, /* Intel x86 code. */
109 FILTER_E8E9 = 2, /* Intel x86 code. */
110 FILTER_ARM = 3, /* ARM code. */
111 FILTER_AUDIO = 4, /* Audio filter, not used in RARv5. */
112 FILTER_RGB = 5, /* Color palette, not used in RARv5. */
113 FILTER_ITANIUM = 6, /* Intel's Itanium, not used in RARv5. */
114 FILTER_PPM = 7, /* Predictive pattern matching, not used in RARv5. */
124 ssize_t block_length;
143 struct decode_table {
145 int32_t decode_len[16];
146 uint32_t decode_pos[16];
148 uint8_t quick_len[1 << 10];
149 uint16_t quick_num[1 << 10];
150 uint16_t decode_num[306];
154 /* Flag used to specify if unpacker needs to reinitialize the uncompression
156 uint8_t initialized : 1;
158 /* Flag used when applying filters. */
159 uint8_t all_filters_applied : 1;
161 /* Flag used to skip file context reinitialization, used when unpacker is
162 * skipping through different multivolume archives. */
163 uint8_t switch_multivolume : 1;
165 /* Flag used to specify if unpacker has processed the whole data block or
166 * just a part of it. */
167 uint8_t block_parsing_finished : 1;
171 int flags; /* Uncompression flags. */
172 int method; /* Uncompression algorithm method. */
173 int version; /* Uncompression algorithm version. */
174 ssize_t window_size; /* Size of window_buf. */
175 uint8_t* window_buf; /* Circular buffer used during
177 uint8_t* filtered_buf; /* Buffer used when applying filters. */
178 const uint8_t* block_buf; /* Buffer used when merging blocks. */
179 size_t window_mask; /* Convinience field; window_size - 1. */
180 int64_t write_ptr; /* This amount of data has been unpacked in
181 the window buffer. */
182 int64_t last_write_ptr; /* This amount of data has been stored in
184 int64_t last_unstore_ptr; /* Counter of bytes extracted during
185 unstoring. This is separate from
186 last_write_ptr because of how SERVICE
187 base blocks are handled during skipping
188 in solid multiarchive archives. */
189 int64_t solid_offset; /* Additional offset inside the window
190 buffer, used in unpacking solid
192 ssize_t cur_block_size; /* Size of current data block. */
193 int last_len; /* Flag used in lzss decompression. */
195 /* Decode tables used during lzss uncompression. */
198 struct decode_table bd; /* huffman bit lengths */
200 struct decode_table ld; /* literals */
202 struct decode_table dd; /* distances */
204 struct decode_table ldd; /* lower bits of distances */
206 struct decode_table rd; /* repeating distances */
207 #define HUFF_TABLE_SIZE (HUFF_NC + HUFF_DC + HUFF_RC + HUFF_LDC)
209 /* Circular deque for storing filters. */
210 struct cdeque filters;
211 int64_t last_block_start; /* Used for sanity checking. */
212 ssize_t last_block_length; /* Used for sanity checking. */
214 /* Distance cache used during lzss uncompression. */
217 /* Data buffer stack. */
218 struct data_ready dready[2];
221 /* Bit reader state. */
223 int8_t bit_addr; /* Current bit pointer inside current byte. */
224 int in_addr; /* Current byte pointer. */
227 /* RARv5 block header structure. */
228 struct compressed_block_header {
231 uint8_t bit_size : 3;
232 uint8_t byte_count : 3;
233 uint8_t is_last_block : 1;
234 uint8_t is_table_present : 1;
236 uint8_t block_flags_u8;
242 /* RARv5 main header structure. */
244 /* Does the archive contain solid streams? */
247 /* If this a multi-file archive? */
255 struct generic_header {
256 uint8_t split_after : 1;
257 uint8_t split_before : 1;
268 /* Main context structure. */
270 int header_initialized;
272 /* Set to 1 if current file is positioned AFTER the magic value
273 * of the archive file. This is used in header reading functions. */
276 /* Set to not zero if we're in skip mode (either by calling rar5_data_skip
277 * function or when skipping over solid streams). Set to 0 when in
278 * extraction mode. This is used during checksum calculation functions. */
281 /* An offset to QuickOpen list. This is not supported by this unpacker,
282 * becuase we're focusing on streaming interface. QuickOpen is designed
283 * to make things quicker for non-stream interfaces, so it's not our
285 uint64_t qlist_offset;
287 /* An offset to additional Recovery data. This is not supported by this
288 * unpacker. Recovery data are additional Reed-Solomon codes that could
289 * be used to calculate bytes that are missing in archive or are
293 /* Various context variables grouped to different structures. */
294 struct generic_header generic;
295 struct main_header main;
296 struct comp_state cstate;
297 struct file_header file;
298 struct bit_reader bits;
299 struct multivolume vol;
301 /* The header of currently processed RARv5 block. Used in main
302 * decompression logic loop. */
303 struct compressed_block_header last_block_hdr;
306 /* Forward function declarations. */
308 static int verify_global_checksums(struct archive_read* a);
309 static int rar5_read_data_skip(struct archive_read *a);
310 static int push_data_ready(struct archive_read* a, struct rar5* rar,
311 const uint8_t* buf, size_t size, int64_t offset);
313 /* CDE_xxx = Circular Double Ended (Queue) return values. */
314 enum CDE_RETURN_VALUES {
315 CDE_OK, CDE_ALLOC, CDE_PARAM, CDE_OUT_OF_BOUNDS,
318 /* Clears the contents of this circular deque. */
319 static void cdeque_clear(struct cdeque* d) {
325 /* Creates a new circular deque object. Capacity must be power of 2: 8, 16, 32,
326 * 64, 256, etc. When the user will add another item above current capacity,
327 * the circular deque will overwrite the oldest entry. */
328 static int cdeque_init(struct cdeque* d, int max_capacity_power_of_2) {
329 if(d == NULL || max_capacity_power_of_2 == 0)
332 d->cap_mask = max_capacity_power_of_2 - 1;
335 if((max_capacity_power_of_2 & d->cap_mask) > 0)
339 d->arr = malloc(sizeof(void*) * max_capacity_power_of_2);
341 return d->arr ? CDE_OK : CDE_ALLOC;
344 /* Return the current size (not capacity) of circular deque `d`. */
345 static size_t cdeque_size(struct cdeque* d) {
349 /* Returns the first element of current circular deque. Note that this function
350 * doesn't perform any bounds checking. If you need bounds checking, use
351 * `cdeque_front()` function instead. */
352 static void cdeque_front_fast(struct cdeque* d, void** value) {
353 *value = (void*) d->arr[d->beg_pos];
356 /* Returns the first element of current circular deque. This function
357 * performs bounds checking. */
358 static int cdeque_front(struct cdeque* d, void** value) {
360 cdeque_front_fast(d, value);
363 return CDE_OUT_OF_BOUNDS;
366 /* Pushes a new element into the end of this circular deque object. If current
367 * size will exceed capacity, the oldest element will be overwritten. */
368 static int cdeque_push_back(struct cdeque* d, void* item) {
372 if(d->size == d->cap_mask + 1)
373 return CDE_OUT_OF_BOUNDS;
375 d->arr[d->end_pos] = (size_t) item;
376 d->end_pos = (d->end_pos + 1) & d->cap_mask;
382 /* Pops a front element of this circular deque object and returns its value.
383 * This function doesn't perform any bounds checking. */
384 static void cdeque_pop_front_fast(struct cdeque* d, void** value) {
385 *value = (void*) d->arr[d->beg_pos];
386 d->beg_pos = (d->beg_pos + 1) & d->cap_mask;
390 /* Pops a front element of this cicrular deque object and returns its value.
391 * This function performs bounds checking. */
392 static int cdeque_pop_front(struct cdeque* d, void** value) {
397 return CDE_OUT_OF_BOUNDS;
399 cdeque_pop_front_fast(d, value);
403 /* Convinience function to cast filter_info** to void **. */
404 static void** cdeque_filter_p(struct filter_info** f) {
405 return (void**) (size_t) f;
408 /* Convinience function to cast filter_info* to void *. */
409 static void* cdeque_filter(struct filter_info* f) {
410 return (void**) (size_t) f;
413 /* Destroys this circular deque object. Dellocates the memory of the collection
414 * buffer, but doesn't deallocate the memory of any pointer passed to this
415 * deque as a value. */
416 static void cdeque_free(struct cdeque* d) {
431 static inline struct rar5* get_context(struct archive_read* a) {
432 return (struct rar5*) a->format->data;
435 // TODO: make sure these functions return a little endian number
437 /* Convinience functions used by filter implementations. */
439 static uint32_t read_filter_data(struct rar5* rar, uint32_t offset) {
440 uint32_t* dptr = (uint32_t*) &rar->cstate.window_buf[offset];
441 // TODO: bswap if big endian
445 static void write_filter_data(struct rar5* rar, uint32_t offset,
448 uint32_t* dptr = (uint32_t*) &rar->cstate.filtered_buf[offset];
449 // TODO: bswap if big endian
453 static void circular_memcpy(uint8_t* dst, uint8_t* window, const int mask,
454 int64_t start, int64_t end)
456 if((start & mask) > (end & mask)) {
457 ssize_t len1 = mask + 1 - (start & mask);
458 ssize_t len2 = end & mask;
460 memcpy(dst, &window[start & mask], len1);
461 memcpy(dst + len1, window, len2);
463 memcpy(dst, &window[start & mask], (size_t) (end - start));
467 /* Allocates a new filter descriptor and adds it to the filter array. */
468 static struct filter_info* add_new_filter(struct rar5* rar) {
469 struct filter_info* f =
470 (struct filter_info*) calloc(1, sizeof(struct filter_info));
476 cdeque_push_back(&rar->cstate.filters, cdeque_filter(f));
480 static int run_delta_filter(struct rar5* rar, struct filter_info* flt) {
482 ssize_t dest_pos, src_pos = 0;
484 for(i = 0; i < flt->channels; i++) {
485 uint8_t prev_byte = 0;
487 dest_pos < flt->block_length;
488 dest_pos += flt->channels)
492 byte = rar->cstate.window_buf[(rar->cstate.solid_offset +
493 flt->block_start + src_pos) & rar->cstate.window_mask];
496 rar->cstate.filtered_buf[dest_pos] = prev_byte;
504 static int run_e8e9_filter(struct rar5* rar, struct filter_info* flt,
507 const uint32_t file_size = 0x1000000;
510 const int mask = (int)rar->cstate.window_mask;
511 circular_memcpy(rar->cstate.filtered_buf,
512 rar->cstate.window_buf,
514 rar->cstate.solid_offset + flt->block_start,
515 rar->cstate.solid_offset + flt->block_start + flt->block_length);
517 for(i = 0; i < flt->block_length - 4;) {
518 uint8_t b = rar->cstate.window_buf[(rar->cstate.solid_offset +
519 flt->block_start + i++) & mask];
521 /* 0xE8 = x86's call <relative_addr_uint32> (function call)
522 * 0xE9 = x86's jmp <relative_addr_uint32> (unconditional jump) */
523 if(b == 0xE8 || (extended && b == 0xE9)) {
526 uint32_t offset = (i + flt->block_start) % file_size;
528 addr = read_filter_data(rar, (uint32_t)(rar->cstate.solid_offset +
529 flt->block_start + i) & rar->cstate.window_mask);
531 if(addr & 0x80000000) {
532 if(((addr + offset) & 0x80000000) == 0) {
533 write_filter_data(rar, (uint32_t)i, addr + file_size);
536 if((addr - file_size) & 0x80000000) {
537 uint32_t naddr = addr - offset;
538 write_filter_data(rar, (uint32_t)i, naddr);
549 static int run_arm_filter(struct rar5* rar, struct filter_info* flt) {
552 const int mask = (int)rar->cstate.window_mask;
554 circular_memcpy(rar->cstate.filtered_buf,
555 rar->cstate.window_buf,
557 rar->cstate.solid_offset + flt->block_start,
558 rar->cstate.solid_offset + flt->block_start + flt->block_length);
560 for(i = 0; i < flt->block_length - 3; i += 4) {
561 uint8_t* b = &rar->cstate.window_buf[(rar->cstate.solid_offset +
562 flt->block_start + i) & mask];
565 /* 0xEB = ARM's BL (branch + link) instruction. */
566 offset = read_filter_data(rar, (rar->cstate.solid_offset +
567 flt->block_start + i) & mask) & 0x00ffffff;
569 offset -= (uint32_t) ((i + flt->block_start) / 4);
570 offset = (offset & 0x00ffffff) | 0xeb000000;
571 write_filter_data(rar, (uint32_t)i, offset);
578 static int run_filter(struct archive_read* a, struct filter_info* flt) {
580 struct rar5* rar = get_context(a);
582 free(rar->cstate.filtered_buf);
584 rar->cstate.filtered_buf = malloc(flt->block_length);
585 if(!rar->cstate.filtered_buf) {
586 archive_set_error(&a->archive, ENOMEM, "Can't allocate memory for "
588 return ARCHIVE_FATAL;
593 ret = run_delta_filter(rar, flt);
599 ret = run_e8e9_filter(rar, flt, flt->type == FILTER_E8E9);
603 ret = run_arm_filter(rar, flt);
607 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
608 "Unsupported filter type: 0x%02x", flt->type);
609 return ARCHIVE_FATAL;
612 if(ret != ARCHIVE_OK) {
613 /* Filter has failed. */
617 if(ARCHIVE_OK != push_data_ready(a, rar, rar->cstate.filtered_buf,
618 flt->block_length, rar->cstate.last_write_ptr))
620 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
621 "Stack overflow when submitting unpacked data");
623 return ARCHIVE_FATAL;
626 rar->cstate.last_write_ptr += flt->block_length;
630 /* The `push_data` function submits the selected data range to the user.
631 * Next call of `use_data` will use the pointer, size and offset arguments
632 * that are specified here. These arguments are pushed to the FIFO stack here,
633 * and popped from the stack by the `use_data` function. */
634 static void push_data(struct archive_read* a, struct rar5* rar,
635 const uint8_t* buf, int64_t idx_begin, int64_t idx_end)
637 const int wmask = (int)rar->cstate.window_mask;
638 const ssize_t solid_write_ptr = (rar->cstate.solid_offset +
639 rar->cstate.last_write_ptr) & wmask;
641 idx_begin += rar->cstate.solid_offset;
642 idx_end += rar->cstate.solid_offset;
644 /* Check if our unpacked data is wrapped inside the window circular buffer.
645 * If it's not wrapped, it can be copied out by using a single memcpy,
646 * but when it's wrapped, we need to copy the first part with one
647 * memcpy, and the second part with another memcpy. */
649 if((idx_begin & wmask) > (idx_end & wmask)) {
650 /* The data is wrapped (begin offset sis bigger than end offset). */
651 const ssize_t frag1_size = rar->cstate.window_size - (idx_begin & wmask);
652 const ssize_t frag2_size = idx_end & wmask;
654 /* Copy the first part of the buffer first. */
655 push_data_ready(a, rar, buf + solid_write_ptr, frag1_size,
656 rar->cstate.last_write_ptr);
658 /* Copy the second part of the buffer. */
659 push_data_ready(a, rar, buf, frag2_size,
660 rar->cstate.last_write_ptr + frag1_size);
662 rar->cstate.last_write_ptr += frag1_size + frag2_size;
664 /* Data is not wrapped, so we can just use one call to copy the
666 push_data_ready(a, rar,
667 buf + solid_write_ptr,
668 (idx_end - idx_begin) & wmask,
669 rar->cstate.last_write_ptr);
671 rar->cstate.last_write_ptr += idx_end - idx_begin;
675 /* Convinience function that submits the data to the user. It uses the
676 * unpack window buffer as a source location. */
677 static void push_window_data(struct archive_read* a, struct rar5* rar,
678 int64_t idx_begin, int64_t idx_end)
680 push_data(a, rar, rar->cstate.window_buf, idx_begin, idx_end);
683 static int apply_filters(struct archive_read* a) {
684 struct filter_info* flt;
685 struct rar5* rar = get_context(a);
688 rar->cstate.all_filters_applied = 0;
690 /* Get the first filter that can be applied to our data. The data needs to
691 * be fully unpacked before the filter can be run. */
693 cdeque_front(&rar->cstate.filters, cdeque_filter_p(&flt)))
695 /* Check if our unpacked data fully covers this filter's range. */
696 if(rar->cstate.write_ptr > flt->block_start &&
697 rar->cstate.write_ptr >= flt->block_start + flt->block_length)
699 /* Check if we have some data pending to be written right before
700 * the filter's start offset. */
701 if(rar->cstate.last_write_ptr == flt->block_start) {
702 /* Run the filter specified by descriptor `flt`. */
703 ret = run_filter(a, flt);
704 if(ret != ARCHIVE_OK) {
705 /* Filter failure, return error. */
709 /* Filter descriptor won't be needed anymore after it's used,
710 * so remove it from the filter list and free its memory. */
711 (void) cdeque_pop_front(&rar->cstate.filters,
712 cdeque_filter_p(&flt));
716 /* We can't run filters yet, dump the memory right before the
718 push_window_data(a, rar, rar->cstate.last_write_ptr,
722 /* Return 'filter applied or not needed' state to the caller. */
723 return ARCHIVE_RETRY;
727 rar->cstate.all_filters_applied = 1;
731 static void dist_cache_push(struct rar5* rar, int value) {
732 int* q = rar->cstate.dist_cache;
740 static int dist_cache_touch(struct rar5* rar, int index) {
741 int* q = rar->cstate.dist_cache;
742 int i, dist = q[index];
744 for(i = index; i > 0; i--)
751 static void free_filters(struct rar5* rar) {
752 struct cdeque* d = &rar->cstate.filters;
754 /* Free any remaining filters. All filters should be naturally consumed by
755 * the unpacking function, so remaining filters after unpacking normally
756 * mean that unpacking wasn't successfull. But still of course we shouldn't
757 * leak memory in such case. */
759 /* cdeque_size() is a fast operation, so we can use it as a loop
761 while(cdeque_size(d) > 0) {
762 struct filter_info* f = NULL;
764 /* Pop_front will also decrease the collection's size. */
765 if (CDE_OK == cdeque_pop_front(d, cdeque_filter_p(&f)))
771 /* Also clear out the variables needed for sanity checking. */
772 rar->cstate.last_block_start = 0;
773 rar->cstate.last_block_length = 0;
776 static void reset_file_context(struct rar5* rar) {
777 memset(&rar->file, 0, sizeof(rar->file));
778 blake2sp_init(&rar->file.b2state, 32);
780 if(rar->main.solid) {
781 rar->cstate.solid_offset += rar->cstate.write_ptr;
783 rar->cstate.solid_offset = 0;
786 rar->cstate.write_ptr = 0;
787 rar->cstate.last_write_ptr = 0;
788 rar->cstate.last_unstore_ptr = 0;
793 static inline int get_archive_read(struct archive* a,
794 struct archive_read** ar)
796 *ar = (struct archive_read*) a;
797 archive_check_magic(a, ARCHIVE_READ_MAGIC, ARCHIVE_STATE_NEW,
798 "archive_read_support_format_rar5");
803 static int read_ahead(struct archive_read* a, size_t how_many,
810 *ptr = __archive_read_ahead(a, how_many, &avail);
819 static int consume(struct archive_read* a, int64_t how_many) {
823 how_many == __archive_read_consume(a, how_many)
831 * Read a RAR5 variable sized numeric value. This value will be stored in
832 * `pvalue`. The `pvalue_len` argument points to a variable that will receive
833 * the byte count that was consumed in order to decode the `pvalue` value, plus
836 * pvalue_len is optional and can be NULL.
838 * NOTE: if `pvalue_len` is NOT NULL, the caller needs to manually consume
839 * the number of bytes that `pvalue_len` value contains. If the `pvalue_len`
840 * is NULL, this consuming operation is done automatically.
842 * Returns 1 if *pvalue was successfully read.
843 * Returns 0 if there was an error. In this case, *pvalue contains an
847 static int read_var(struct archive_read* a, uint64_t* pvalue,
848 uint64_t* pvalue_len)
855 /* We will read maximum of 8 bytes. We don't have to handle the situation
856 * to read the RAR5 variable-sized value stored at the end of the file,
857 * because such situation will never happen. */
858 if(!read_ahead(a, 8, &p))
861 for(shift = 0, i = 0; i < 8; i++, shift += 7) {
864 /* Strip the MSB from the input byte and add the resulting number
865 * to the `result`. */
866 result += (b & (uint64_t)0x7F) << shift;
868 /* MSB set to 1 means we need to continue decoding process. MSB set
869 * to 0 means we're done.
871 * This conditional checks for the second case. */
872 if((b & 0x80) == 0) {
877 /* If the caller has passed the `pvalue_len` pointer, store the
878 * number of consumed bytes in it and do NOT consume those bytes,
879 * since the caller has all the information it needs to perform
880 * the consuming process itself. */
884 /* If the caller did not provide the `pvalue_len` pointer,
885 * it will not have the possibility to advance the file
886 * pointer, because it will not know how many bytes it needs
887 * to consume. This is why we handle such situation here
889 if(ARCHIVE_OK != consume(a, 1 + i)) {
894 /* End of decoding process, return success. */
899 /* The decoded value takes the maximum number of 8 bytes. It's a maximum
900 * number of bytes, so end decoding process here even if the first bit
901 * of last byte is 1. */
909 if(ARCHIVE_OK != consume(a, 9)) {
917 static int read_var_sized(struct archive_read* a, size_t* pvalue,
923 const int ret = pvalue_len
924 ? read_var(a, &v, &v_size)
925 : read_var(a, &v, NULL);
927 if(ret == 1 && pvalue) {
928 *pvalue = (size_t) v;
932 /* Possible data truncation should be safe. */
933 *pvalue_len = (size_t) v_size;
939 static int read_bits_32(struct rar5* rar, const uint8_t* p, uint32_t* value) {
940 uint32_t bits = p[rar->bits.in_addr] << 24;
941 bits |= p[rar->bits.in_addr + 1] << 16;
942 bits |= p[rar->bits.in_addr + 2] << 8;
943 bits |= p[rar->bits.in_addr + 3];
944 bits <<= rar->bits.bit_addr;
945 bits |= p[rar->bits.in_addr + 4] >> (8 - rar->bits.bit_addr);
950 static int read_bits_16(struct rar5* rar, const uint8_t* p, uint16_t* value) {
951 int bits = (int) p[rar->bits.in_addr] << 16;
952 bits |= (int) p[rar->bits.in_addr + 1] << 8;
953 bits |= (int) p[rar->bits.in_addr + 2];
954 bits >>= (8 - rar->bits.bit_addr);
955 *value = bits & 0xffff;
959 static void skip_bits(struct rar5* rar, int bits) {
960 const int new_bits = rar->bits.bit_addr + bits;
961 rar->bits.in_addr += new_bits >> 3;
962 rar->bits.bit_addr = new_bits & 7;
966 static int read_consume_bits(struct rar5* rar, const uint8_t* p, int n,
972 if(n == 0 || n > 16) {
973 /* This is a programmer error and should never happen in runtime. */
974 return ARCHIVE_FATAL;
977 ret = read_bits_16(rar, p, &v);
978 if(ret != ARCHIVE_OK)
992 static int read_u32(struct archive_read* a, uint32_t* pvalue) {
994 if(!read_ahead(a, 4, &p))
997 *pvalue = *(const uint32_t*)p;
999 return ARCHIVE_OK == consume(a, 4) ? 1 : 0;
1002 static int read_u64(struct archive_read* a, uint64_t* pvalue) {
1004 if(!read_ahead(a, 8, &p))
1007 *pvalue = *(const uint64_t*)p;
1009 return ARCHIVE_OK == consume(a, 8) ? 1 : 0;
1012 static int bid_standard(struct archive_read* a) {
1015 if(!read_ahead(a, rar5_signature_size, &p))
1018 if(!memcmp(rar5_signature, p, rar5_signature_size))
1024 static int rar5_bid(struct archive_read* a, int best_bid) {
1030 my_bid = bid_standard(a);
1038 static int rar5_options(struct archive_read *a, const char *key, const char *val) {
1043 /* No options supported in this version. Return the ARCHIVE_WARN code to
1044 * signal the options supervisor that the unpacker didn't handle setting
1047 return ARCHIVE_WARN;
1050 static void init_header(struct archive_read* a) {
1051 a->archive.archive_format = ARCHIVE_FORMAT_RAR_V5;
1052 a->archive.archive_format_name = "RAR5";
1056 HFL_EXTRA_DATA = 0x0001, HFL_DATA = 0x0002, HFL_SKIP_IF_UNKNOWN = 0x0004,
1057 HFL_SPLIT_BEFORE = 0x0008, HFL_SPLIT_AFTER = 0x0010, HFL_CHILD = 0x0020,
1058 HFL_INHERITED = 0x0040
1061 static int process_main_locator_extra_block(struct archive_read* a,
1064 uint64_t locator_flags;
1066 if(!read_var(a, &locator_flags, NULL)) {
1070 enum LOCATOR_FLAGS {
1071 QLIST = 0x01, RECOVERY = 0x02,
1074 if(locator_flags & QLIST) {
1075 if(!read_var(a, &rar->qlist_offset, NULL)) {
1079 /* qlist is not used */
1082 if(locator_flags & RECOVERY) {
1083 if(!read_var(a, &rar->rr_offset, NULL)) {
1087 /* rr is not used */
1093 static int parse_file_extra_hash(struct archive_read* a, struct rar5* rar,
1094 ssize_t* extra_data_size)
1099 if(!read_var_sized(a, &hash_type, &value_len))
1102 *extra_data_size -= value_len;
1103 if(ARCHIVE_OK != consume(a, value_len)) {
1111 /* The file uses BLAKE2sp checksum algorithm instead of plain old
1113 if(hash_type == BLAKE2sp) {
1115 const int hash_size = sizeof(rar->file.blake2sp);
1117 if(!read_ahead(a, hash_size, &p))
1120 rar->file.has_blake2 = 1;
1121 memcpy(&rar->file.blake2sp, p, hash_size);
1123 if(ARCHIVE_OK != consume(a, hash_size)) {
1127 *extra_data_size -= hash_size;
1129 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1130 "Unsupported hash type (0x%02x)", (int) hash_type);
1131 return ARCHIVE_FATAL;
1137 static uint64_t time_win_to_unix(uint64_t win_time) {
1138 const size_t ns_in_sec = 10000000;
1139 const uint64_t sec_to_unix = 11644473600LL;
1140 return win_time / ns_in_sec - sec_to_unix;
1143 static int parse_htime_item(struct archive_read* a, char unix_time,
1144 uint64_t* where, ssize_t* extra_data_size)
1148 if(!read_u32(a, &time_val))
1151 *extra_data_size -= 4;
1152 *where = (uint64_t) time_val;
1154 uint64_t windows_time;
1155 if(!read_u64(a, &windows_time))
1158 *where = time_win_to_unix(windows_time);
1159 *extra_data_size -= 8;
1165 static int parse_file_extra_htime(struct archive_read* a,
1166 struct archive_entry* e, struct rar5* rar,
1167 ssize_t* extra_data_size)
1181 if(!read_var_sized(a, &flags, &value_len))
1184 *extra_data_size -= value_len;
1185 if(ARCHIVE_OK != consume(a, value_len)) {
1189 unix_time = flags & IS_UNIX;
1191 if(flags & HAS_MTIME) {
1192 parse_htime_item(a, unix_time, &rar->file.e_mtime, extra_data_size);
1193 archive_entry_set_mtime(e, rar->file.e_mtime, 0);
1196 if(flags & HAS_CTIME) {
1197 parse_htime_item(a, unix_time, &rar->file.e_ctime, extra_data_size);
1198 archive_entry_set_ctime(e, rar->file.e_ctime, 0);
1201 if(flags & HAS_ATIME) {
1202 parse_htime_item(a, unix_time, &rar->file.e_atime, extra_data_size);
1203 archive_entry_set_atime(e, rar->file.e_atime, 0);
1206 if(flags & HAS_UNIX_NS) {
1207 if(!read_u32(a, &rar->file.e_unix_ns))
1210 *extra_data_size -= 4;
1216 static int process_head_file_extra(struct archive_read* a,
1217 struct archive_entry* e, struct rar5* rar,
1218 ssize_t extra_data_size)
1220 size_t extra_field_size;
1221 size_t extra_field_id;
1222 int ret = ARCHIVE_FATAL;
1226 CRYPT = 0x01, HASH = 0x02, HTIME = 0x03, VERSION_ = 0x04,
1227 REDIR = 0x05, UOWNER = 0x06, SUBDATA = 0x07
1230 while(extra_data_size > 0) {
1231 if(!read_var_sized(a, &extra_field_size, &var_size))
1234 extra_data_size -= var_size;
1235 if(ARCHIVE_OK != consume(a, var_size)) {
1239 if(!read_var_sized(a, &extra_field_id, &var_size))
1242 extra_data_size -= var_size;
1243 if(ARCHIVE_OK != consume(a, var_size)) {
1247 switch(extra_field_id) {
1249 ret = parse_file_extra_hash(a, rar, &extra_data_size);
1252 ret = parse_file_extra_htime(a, e, rar, &extra_data_size);
1265 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1266 "Unknown extra field in file/service block: 0x%02x",
1267 (int) extra_field_id);
1268 return ARCHIVE_FATAL;
1272 if(ret != ARCHIVE_OK) {
1273 /* Attribute not implemented. */
1280 static int process_head_file(struct archive_read* a, struct rar5* rar,
1281 struct archive_entry* entry, size_t block_flags)
1283 ssize_t extra_data_size = 0;
1284 size_t data_size, file_flags, file_attr, compression_info, host_os,
1286 uint64_t unpacked_size;
1287 uint32_t mtime = 0, crc;
1288 int c_method = 0, c_version = 0, is_dir;
1289 char name_utf8_buf[2048 * 4];
1292 archive_entry_clear(entry);
1294 /* Do not reset file context if we're switching archives. */
1295 if(!rar->cstate.switch_multivolume) {
1296 reset_file_context(rar);
1299 if(block_flags & HFL_EXTRA_DATA) {
1301 if(!read_var_sized(a, &edata_size, NULL))
1304 /* Intentional type cast from unsigned to signed. */
1305 extra_data_size = (ssize_t) edata_size;
1308 if(block_flags & HFL_DATA) {
1309 if(!read_var_sized(a, &data_size, NULL))
1312 rar->file.bytes_remaining = data_size;
1314 rar->file.bytes_remaining = 0;
1316 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1317 "no data found in file/service block");
1318 return ARCHIVE_FATAL;
1322 DIRECTORY = 0x0001, UTIME = 0x0002, CRC32 = 0x0004,
1323 UNKNOWN_UNPACKED_SIZE = 0x0008,
1326 enum COMP_INFO_FLAGS {
1330 if(!read_var_sized(a, &file_flags, NULL))
1333 if(!read_var(a, &unpacked_size, NULL))
1336 if(file_flags & UNKNOWN_UNPACKED_SIZE) {
1337 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
1338 "Files with unknown unpacked size are not supported");
1339 return ARCHIVE_FATAL;
1342 is_dir = (int) (file_flags & DIRECTORY);
1344 if(!read_var_sized(a, &file_attr, NULL))
1347 if(file_flags & UTIME) {
1348 if(!read_u32(a, &mtime))
1352 if(file_flags & CRC32) {
1353 if(!read_u32(a, &crc))
1357 if(!read_var_sized(a, &compression_info, NULL))
1360 c_method = (int) (compression_info >> 7) & 0x7;
1361 c_version = (int) (compression_info & 0x3f);
1363 rar->cstate.window_size = is_dir ?
1365 g_unpack_window_size << ((compression_info >> 10) & 15);
1366 rar->cstate.method = c_method;
1367 rar->cstate.version = c_version + 50;
1369 rar->file.solid = (compression_info & SOLID) > 0;
1370 rar->file.service = 0;
1372 if(!read_var_sized(a, &host_os, NULL))
1380 if(host_os == HOST_WINDOWS) {
1381 /* Host OS is Windows */
1383 unsigned short mode = 0660;
1390 archive_entry_set_mode(entry, mode);
1391 } else if(host_os == HOST_UNIX) {
1392 /* Host OS is Unix */
1393 archive_entry_set_mode(entry, (unsigned short) file_attr);
1395 /* Unknown host OS */
1396 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1397 "Unsupported Host OS: 0x%02x", (int) host_os);
1399 return ARCHIVE_FATAL;
1402 if(!read_var_sized(a, &name_size, NULL))
1405 if(!read_ahead(a, name_size, &p))
1408 if(name_size > 2047) {
1409 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1410 "Filename is too long");
1412 return ARCHIVE_FATAL;
1415 if(name_size == 0) {
1416 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1417 "No filename specified");
1419 return ARCHIVE_FATAL;
1422 memcpy(name_utf8_buf, p, name_size);
1423 name_utf8_buf[name_size] = 0;
1424 if(ARCHIVE_OK != consume(a, name_size)) {
1428 if(extra_data_size > 0) {
1429 int ret = process_head_file_extra(a, entry, rar, extra_data_size);
1432 if(extra_data_size < 0) {
1433 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
1434 "File extra data size is not zero");
1435 return ARCHIVE_FATAL;
1438 if(ret != ARCHIVE_OK)
1442 if((file_flags & UNKNOWN_UNPACKED_SIZE) == 0) {
1443 rar->file.unpacked_size = (ssize_t) unpacked_size;
1444 archive_entry_set_size(entry, unpacked_size);
1447 if(file_flags & UTIME) {
1448 archive_entry_set_mtime(entry, (time_t) mtime, 0);
1451 if(file_flags & CRC32) {
1452 rar->file.stored_crc32 = crc;
1455 archive_entry_update_pathname_utf8(entry, name_utf8_buf);
1457 if(!rar->cstate.switch_multivolume) {
1458 /* Do not reinitialize unpacking state if we're switching archives. */
1459 rar->cstate.block_parsing_finished = 1;
1460 rar->cstate.all_filters_applied = 1;
1461 rar->cstate.initialized = 0;
1464 if(rar->generic.split_before > 0) {
1465 /* If now we're standing on a header that has a 'split before' mark,
1466 * it means we're standing on a 'continuation' file header. Signal
1467 * the caller that if it wants to move to another file, it must call
1468 * rar5_read_header() function again. */
1470 return ARCHIVE_RETRY;
1476 static int process_head_service(struct archive_read* a, struct rar5* rar,
1477 struct archive_entry* entry, size_t block_flags)
1479 /* Process this SERVICE block the same way as FILE blocks. */
1480 int ret = process_head_file(a, rar, entry, block_flags);
1481 if(ret != ARCHIVE_OK)
1484 rar->file.service = 1;
1486 /* But skip the data part automatically. It's no use for the user anyway.
1487 * It contains only service data, not even needed to properly unpack the
1489 ret = rar5_read_data_skip(a);
1490 if(ret != ARCHIVE_OK)
1493 /* After skipping, try parsing another block automatically. */
1494 return ARCHIVE_RETRY;
1497 static int process_head_main(struct archive_read* a, struct rar5* rar,
1498 struct archive_entry* entry, size_t block_flags)
1503 size_t extra_data_size,
1508 if(block_flags & HFL_EXTRA_DATA) {
1509 if(!read_var_sized(a, &extra_data_size, NULL))
1512 extra_data_size = 0;
1515 if(!read_var_sized(a, &archive_flags, NULL)) {
1520 VOLUME = 0x0001, /* multi-volume archive */
1521 VOLUME_NUMBER = 0x0002, /* volume number, first vol doesnt have it */
1522 SOLID = 0x0004, /* solid archive */
1523 PROTECT = 0x0008, /* contains Recovery info */
1524 LOCK = 0x0010, /* readonly flag, not used */
1527 rar->main.volume = (archive_flags & VOLUME) > 0;
1528 rar->main.solid = (archive_flags & SOLID) > 0;
1530 if(archive_flags & VOLUME_NUMBER) {
1532 if(!read_var_sized(a, &v, NULL)) {
1536 rar->main.vol_no = (int) v;
1538 rar->main.vol_no = 0;
1541 if(rar->vol.expected_vol_no > 0 &&
1542 rar->main.vol_no != rar->vol.expected_vol_no)
1544 /* Returning EOF instead of FATAL because of strange libarchive
1545 * behavior. When opening multiple files via
1546 * archive_read_open_filenames(), after reading up the whole last file,
1547 * the __archive_read_ahead function wraps up to the first archive
1548 * instead of returning EOF. */
1552 if(extra_data_size == 0) {
1557 if(!read_var_sized(a, &extra_field_size, NULL)) {
1561 if(!read_var_sized(a, &extra_field_id, NULL)) {
1565 if(extra_field_size == 0) {
1566 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1567 "Invalid extra field size");
1568 return ARCHIVE_FATAL;
1572 // Just one attribute here.
1576 switch(extra_field_id) {
1578 ret = process_main_locator_extra_block(a, rar);
1579 if(ret != ARCHIVE_OK) {
1580 /* Error while parsing main locator extra block. */
1586 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1587 "Unsupported extra type (0x%02x)", (int) extra_field_id);
1588 return ARCHIVE_FATAL;
1594 static int scan_for_signature(struct archive_read* a);
1596 /* Base block processing function. A 'base block' is a RARv5 header block
1597 * that tells the reader what kind of data is stored inside the block.
1599 * From the birds-eye view a RAR file looks file this:
1601 * <magic><base_block_1><base_block_2>...<base_block_n>
1603 * There are a few types of base blocks. Those types are specified inside
1604 * the 'switch' statement in this function. For example purposes, I'll write
1605 * how a standard RARv5 file could look like here:
1607 * <magic><MAIN><FILE><FILE><FILE><SERVICE><ENDARC>
1609 * The structure above could describe an archive file with 3 files in it,
1610 * one service "QuickOpen" block (that is ignored by this parser), and an
1611 * end of file base block marker.
1613 * If the file is stored in multiple archive files ("multiarchive"), it might
1616 * .part01.rar: <magic><MAIN><FILE><ENDARC>
1617 * .part02.rar: <magic><MAIN><FILE><ENDARC>
1618 * .part03.rar: <magic><MAIN><FILE><ENDARC>
1620 * This example could describe 3 RAR files that contain ONE archived file.
1621 * Or it could describe 3 RAR files that contain 3 different files. Or 3
1622 * RAR files than contain 2 files. It all depends what metadata is stored in
1623 * the headers of <FILE> blocks.
1625 * Each <FILE> block contains info about its size, the name of the file it's
1626 * storing inside, and whether this FILE block is a continuation block of
1627 * previous archive ('split before'), and is this FILE block should be
1628 * continued in another archive ('split after'). By parsing the 'split before'
1629 * and 'split after' flags, we're able to tell if multiple <FILE> base blocks
1630 * are describing one file, or multiple files (with the same filename, for
1633 * One thing to note is that if we're parsing the first <FILE> block, and
1634 * we see 'split after' flag, then we need to jump over to another <FILE>
1635 * block to be able to decompress rest of the data. To do this, we need
1636 * to skip the <ENDARC> block, then switch to another file, then skip the
1637 * <magic> block, <MAIN> block, and then we're standing on the proper
1641 static int process_base_block(struct archive_read* a,
1642 struct archive_entry* entry)
1644 struct rar5* rar = get_context(a);
1645 uint32_t hdr_crc, computed_crc;
1646 size_t raw_hdr_size, hdr_size_len, hdr_size;
1647 size_t header_id, header_flags;
1651 /* Skip any unprocessed data for this file. */
1652 if(rar->file.bytes_remaining) {
1653 ret = rar5_read_data_skip(a);
1654 if(ret != ARCHIVE_OK) {
1659 /* Read the expected CRC32 checksum. */
1660 if(!read_u32(a, &hdr_crc)) {
1664 /* Read header size. */
1665 if(!read_var_sized(a, &raw_hdr_size, &hdr_size_len)) {
1669 /* Sanity check, maximum header size for RAR5 is 2MB. */
1670 if(raw_hdr_size > (2 * 1024 * 1024)) {
1671 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1672 "Base block header is too large");
1674 return ARCHIVE_FATAL;
1677 hdr_size = raw_hdr_size + hdr_size_len;
1679 /* Read the whole header data into memory, maximum memory use here is
1681 if(!read_ahead(a, hdr_size, &p)) {
1685 /* Verify the CRC32 of the header data. */
1686 computed_crc = (uint32_t) crc32(0, p, (int) hdr_size);
1687 if(computed_crc != hdr_crc) {
1688 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1689 "Header CRC error");
1691 return ARCHIVE_FATAL;
1694 /* If the checksum is OK, we proceed with parsing. */
1695 if(ARCHIVE_OK != consume(a, hdr_size_len)) {
1699 if(!read_var_sized(a, &header_id, NULL))
1702 if(!read_var_sized(a, &header_flags, NULL))
1705 rar->generic.split_after = (header_flags & HFL_SPLIT_AFTER) > 0;
1706 rar->generic.split_before = (header_flags & HFL_SPLIT_BEFORE) > 0;
1707 rar->generic.size = (int)hdr_size;
1708 rar->generic.last_header_id = (int)header_id;
1709 rar->main.endarc = 0;
1711 /* Those are possible header ids in RARv5. */
1713 HEAD_MARK = 0x00, HEAD_MAIN = 0x01, HEAD_FILE = 0x02,
1714 HEAD_SERVICE = 0x03, HEAD_CRYPT = 0x04, HEAD_ENDARC = 0x05,
1715 HEAD_UNKNOWN = 0xff,
1720 ret = process_head_main(a, rar, entry, header_flags);
1722 /* Main header doesn't have any files in it, so it's pointless
1723 * to return to the caller. Retry to next header, which should be
1724 * HEAD_FILE/HEAD_SERVICE. */
1725 if(ret == ARCHIVE_OK)
1726 return ARCHIVE_RETRY;
1730 ret = process_head_service(a, rar, entry, header_flags);
1733 ret = process_head_file(a, rar, entry, header_flags);
1736 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1737 "Encryption is not supported");
1738 return ARCHIVE_FATAL;
1740 rar->main.endarc = 1;
1742 /* After encountering an end of file marker, we need to take
1743 * into consideration if this archive is continued in another
1744 * file (i.e. is it part01.rar: is there a part02.rar?) */
1745 if(rar->main.volume) {
1746 /* In case there is part02.rar, position the read pointer
1747 * in a proper place, so we can resume parsing. */
1749 ret = scan_for_signature(a);
1750 if(ret == ARCHIVE_FATAL) {
1753 rar->vol.expected_vol_no = rar->main.vol_no + 1;
1762 if((header_flags & HFL_SKIP_IF_UNKNOWN) == 0) {
1763 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1764 "Header type error");
1765 return ARCHIVE_FATAL;
1767 /* If the block is marked as 'skip if unknown', do as the flag
1768 * says: skip the block instead on failing on it. */
1769 return ARCHIVE_RETRY;
1775 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
1776 "Internal unpacker error");
1777 return ARCHIVE_FATAL;
1781 static int skip_base_block(struct archive_read* a) {
1783 struct rar5* rar = get_context(a);
1785 /* Create a new local archive_entry structure that will be operated on
1786 * by header reader; operations on this archive_entry will be discarded.
1788 struct archive_entry* entry = archive_entry_new();
1789 ret = process_base_block(a, entry);
1791 /* Discard operations on this archive_entry structure. */
1792 archive_entry_free(entry);
1794 if(rar->generic.last_header_id == 2 && rar->generic.split_before > 0)
1797 if(ret == ARCHIVE_OK)
1798 return ARCHIVE_RETRY;
1803 static int rar5_read_header(struct archive_read *a,
1804 struct archive_entry *entry)
1806 struct rar5* rar = get_context(a);
1809 if(rar->header_initialized == 0) {
1811 rar->header_initialized = 1;
1814 if(rar->skipped_magic == 0) {
1815 if(ARCHIVE_OK != consume(a, rar5_signature_size)) {
1819 rar->skipped_magic = 1;
1823 ret = process_base_block(a, entry);
1824 } while(ret == ARCHIVE_RETRY ||
1825 (rar->main.endarc > 0 && ret == ARCHIVE_OK));
1830 static void init_unpack(struct rar5* rar) {
1831 rar->file.calculated_crc32 = 0;
1832 if (rar->cstate.window_size)
1833 rar->cstate.window_mask = rar->cstate.window_size - 1;
1835 rar->cstate.window_mask = 0;
1837 free(rar->cstate.window_buf);
1839 free(rar->cstate.filtered_buf);
1841 rar->cstate.window_buf = calloc(1, rar->cstate.window_size);
1842 rar->cstate.filtered_buf = calloc(1, rar->cstate.window_size);
1844 rar->cstate.write_ptr = 0;
1845 rar->cstate.last_write_ptr = 0;
1847 memset(&rar->cstate.bd, 0, sizeof(rar->cstate.bd));
1848 memset(&rar->cstate.ld, 0, sizeof(rar->cstate.ld));
1849 memset(&rar->cstate.dd, 0, sizeof(rar->cstate.dd));
1850 memset(&rar->cstate.ldd, 0, sizeof(rar->cstate.ldd));
1851 memset(&rar->cstate.rd, 0, sizeof(rar->cstate.rd));
1854 static void update_crc(struct rar5* rar, const uint8_t* p, size_t to_read) {
1857 if(rar->skip_mode) {
1858 #if defined CHECK_CRC_ON_SOLID_SKIP
1867 /* Don't update CRC32 if the file doesn't have the `stored_crc32` info
1869 if(rar->file.stored_crc32 > 0) {
1870 rar->file.calculated_crc32 =
1871 crc32(rar->file.calculated_crc32, p, to_read);
1874 /* Check if the file uses an optional BLAKE2sp checksum algorithm. */
1875 if(rar->file.has_blake2 > 0) {
1876 /* Return value of the `update` function is always 0, so we can
1877 * explicitly ignore it here. */
1878 (void) blake2sp_update(&rar->file.b2state, p, to_read);
1883 static int create_decode_tables(uint8_t* bit_length,
1884 struct decode_table* table,
1887 int code, upper_limit = 0, i, lc[16];
1888 uint32_t decode_pos_clone[rar5_countof(table->decode_pos)];
1889 ssize_t cur_len, quick_data_size;
1891 memset(&lc, 0, sizeof(lc));
1892 memset(table->decode_num, 0, sizeof(table->decode_num));
1894 table->quick_bits = size == HUFF_NC ? 10 : 7;
1896 for(i = 0; i < size; i++) {
1897 lc[bit_length[i] & 15]++;
1901 table->decode_pos[0] = 0;
1902 table->decode_len[0] = 0;
1904 for(i = 1; i < 16; i++) {
1905 upper_limit += lc[i];
1907 table->decode_len[i] = upper_limit << (16 - i);
1908 table->decode_pos[i] = table->decode_pos[i - 1] + lc[i - 1];
1913 memcpy(decode_pos_clone, table->decode_pos, sizeof(decode_pos_clone));
1915 for(i = 0; i < size; i++) {
1916 uint8_t clen = bit_length[i] & 15;
1918 int last_pos = decode_pos_clone[clen];
1919 table->decode_num[last_pos] = i;
1920 decode_pos_clone[clen]++;
1924 quick_data_size = (int64_t)1 << table->quick_bits;
1926 for(code = 0; code < quick_data_size; code++) {
1927 int bit_field = code << (16 - table->quick_bits);
1930 while(cur_len < rar5_countof(table->decode_len) &&
1931 bit_field >= table->decode_len[cur_len]) {
1935 table->quick_len[code] = (uint8_t) cur_len;
1937 dist = bit_field - table->decode_len[cur_len - 1];
1938 dist >>= (16 - cur_len);
1940 pos = table->decode_pos[cur_len] + dist;
1941 if(cur_len < rar5_countof(table->decode_pos) && pos < size) {
1942 table->quick_num[code] = table->decode_num[pos];
1944 table->quick_num[code] = 0;
1951 static int decode_number(struct archive_read* a, struct decode_table* table,
1952 const uint8_t* p, uint16_t* num)
1957 struct rar5* rar = get_context(a);
1959 if(ARCHIVE_OK != read_bits_16(rar, p, &bitfield)) {
1965 if(bitfield < table->decode_len[table->quick_bits]) {
1966 int code = bitfield >> (16 - table->quick_bits);
1967 skip_bits(rar, table->quick_len[code]);
1968 *num = table->quick_num[code];
1974 for(i = table->quick_bits + 1; i < 15; i++) {
1975 if(bitfield < table->decode_len[i]) {
1981 skip_bits(rar, bits);
1983 dist = bitfield - table->decode_len[bits - 1];
1984 dist >>= (16 - bits);
1985 pos = table->decode_pos[bits] + dist;
1987 if(pos >= table->size)
1990 *num = table->decode_num[pos];
1994 /* Reads and parses Huffman tables from the beginning of the block. */
1995 static int parse_tables(struct archive_read* a, struct rar5* rar,
1998 int ret, value, i, w, idx = 0;
1999 uint8_t bit_length[HUFF_BC],
2000 table[HUFF_TABLE_SIZE],
2004 enum { ESCAPE = 15 };
2006 /* The data for table generation is compressed using a simple RLE-like
2007 * algorithm when storing zeroes, so we need to unpack it first. */
2008 for(w = 0, i = 0; w < HUFF_BC;) {
2009 value = (p[i] & nibble_mask) >> nibble_shift;
2011 if(nibble_mask == 0x0F)
2014 nibble_mask ^= 0xFF;
2017 /* Values smaller than 15 is data, so we write it directly. Value 15
2018 * is a flag telling us that we need to unpack more bytes. */
2019 if(value == ESCAPE) {
2020 value = (p[i] & nibble_mask) >> nibble_shift;
2021 if(nibble_mask == 0x0F)
2023 nibble_mask ^= 0xFF;
2027 /* We sometimes need to write the actual value of 15, so this
2028 * case handles that. */
2029 bit_length[w++] = ESCAPE;
2034 for(k = 0; k < value + 2; k++) {
2035 bit_length[w++] = 0;
2039 bit_length[w++] = value;
2043 rar->bits.in_addr = i;
2044 rar->bits.bit_addr = nibble_shift ^ 4;
2046 ret = create_decode_tables(bit_length, &rar->cstate.bd, HUFF_BC);
2047 if(ret != ARCHIVE_OK) {
2048 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2049 "Decoding huffman tables failed");
2050 return ARCHIVE_FATAL;
2053 for(i = 0; i < HUFF_TABLE_SIZE;) {
2056 ret = decode_number(a, &rar->cstate.bd, p, &num);
2057 if(ret != ARCHIVE_OK) {
2058 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2059 "Decoding huffman tables failed");
2060 return ARCHIVE_FATAL;
2064 /* 0..15: store directly */
2065 table[i] = (uint8_t) num;
2071 /* 16..17: repeat previous code */
2073 if(ARCHIVE_OK != read_bits_16(rar, p, &n))
2087 while(n-- > 0 && i < HUFF_TABLE_SIZE) {
2088 table[i] = table[i - 1];
2092 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2093 "Unexpected error when decoding huffman tables");
2094 return ARCHIVE_FATAL;
2100 /* other codes: fill with zeroes `n` times */
2102 if(ARCHIVE_OK != read_bits_16(rar, p, &n))
2115 while(n-- > 0 && i < HUFF_TABLE_SIZE)
2119 ret = create_decode_tables(&table[idx], &rar->cstate.ld, HUFF_NC);
2120 if(ret != ARCHIVE_OK) {
2121 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2122 "Failed to create literal table");
2123 return ARCHIVE_FATAL;
2128 ret = create_decode_tables(&table[idx], &rar->cstate.dd, HUFF_DC);
2129 if(ret != ARCHIVE_OK) {
2130 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2131 "Failed to create distance table");
2132 return ARCHIVE_FATAL;
2137 ret = create_decode_tables(&table[idx], &rar->cstate.ldd, HUFF_LDC);
2138 if(ret != ARCHIVE_OK) {
2139 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2140 "Failed to create lower bits of distances table");
2141 return ARCHIVE_FATAL;
2146 ret = create_decode_tables(&table[idx], &rar->cstate.rd, HUFF_RC);
2147 if(ret != ARCHIVE_OK) {
2148 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2149 "Failed to create repeating distances table");
2150 return ARCHIVE_FATAL;
2156 /* Parses the block header, verifies its CRC byte, and saves the header
2157 * fields inside the `hdr` pointer. */
2158 static int parse_block_header(struct archive_read* a, const uint8_t* p,
2159 ssize_t* block_size, struct compressed_block_header* hdr)
2161 memcpy(hdr, p, sizeof(struct compressed_block_header));
2163 if(hdr->block_flags.byte_count > 2) {
2164 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2165 "Unsupported block header size (was %d, max is 2)",
2166 hdr->block_flags.byte_count);
2167 return ARCHIVE_FATAL;
2170 /* This should probably use bit reader interface in order to be more
2173 switch(hdr->block_flags.byte_count) {
2174 /* 1-byte block size */
2176 *block_size = *(const uint8_t*) &p[2];
2179 /* 2-byte block size */
2181 *block_size = *(const uint16_t*) &p[2];
2184 /* 3-byte block size */
2186 *block_size = *(const uint32_t*) &p[2];
2187 *block_size &= 0x00FFFFFF;
2190 /* Other block sizes are not supported. This case is not reached,
2191 * because we have an 'if' guard before the switch that makes sure
2194 return ARCHIVE_FATAL;
2197 /* Verify the block header checksum. 0x5A is a magic value and is always
2199 uint8_t calculated_cksum = 0x5A
2200 ^ (uint8_t) hdr->block_flags_u8
2201 ^ (uint8_t) *block_size
2202 ^ (uint8_t) (*block_size >> 8)
2203 ^ (uint8_t) (*block_size >> 16);
2205 if(calculated_cksum != hdr->block_cksum) {
2206 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2207 "Block checksum error: got 0x%02x, expected 0x%02x",
2208 hdr->block_cksum, calculated_cksum);
2210 return ARCHIVE_FATAL;
2216 /* Convinience function used during filter processing. */
2217 static int parse_filter_data(struct rar5* rar, const uint8_t* p,
2218 uint32_t* filter_data)
2223 if(ARCHIVE_OK != read_consume_bits(rar, p, 2, &bytes))
2228 for(i = 0; i < bytes; i++) {
2231 if(ARCHIVE_OK != read_bits_16(rar, p, &byte)) {
2235 data += (byte >> 8) << (i * 8);
2239 *filter_data = data;
2243 /* Function is used during sanity checking. */
2244 static int is_valid_filter_block_start(struct rar5* rar,
2247 const int64_t block_start = (ssize_t) start + rar->cstate.write_ptr;
2248 const int64_t last_bs = rar->cstate.last_block_start;
2249 const ssize_t last_bl = rar->cstate.last_block_length;
2251 if(last_bs == 0 || last_bl == 0) {
2252 /* We didn't have any filters yet, so accept this offset. */
2256 if(block_start >= last_bs + last_bl) {
2257 /* Current offset is bigger than last block's end offset, so
2258 * accept current offset. */
2262 /* Any other case is not a normal situation and we should fail. */
2266 /* The function will create a new filter, read its parameters from the input
2267 * stream and add it to the filter collection. */
2268 static int parse_filter(struct archive_read* ar, const uint8_t* p) {
2269 uint32_t block_start, block_length;
2270 uint16_t filter_type;
2271 struct rar5* rar = get_context(ar);
2273 /* Read the parameters from the input stream. */
2274 if(ARCHIVE_OK != parse_filter_data(rar, p, &block_start))
2277 if(ARCHIVE_OK != parse_filter_data(rar, p, &block_length))
2280 if(ARCHIVE_OK != read_bits_16(rar, p, &filter_type))
2286 /* Perform some sanity checks on this filter parameters. Note that we
2287 * allow only DELTA, E8/E9 and ARM filters here, because rest of filters
2288 * are not used in RARv5. */
2290 if(block_length < 4 ||
2291 block_length > 0x400000 ||
2292 filter_type > FILTER_ARM ||
2293 !is_valid_filter_block_start(rar, block_start))
2295 archive_set_error(&ar->archive, ARCHIVE_ERRNO_FILE_FORMAT, "Invalid "
2296 "filter encountered");
2297 return ARCHIVE_FATAL;
2300 /* Allocate a new filter. */
2301 struct filter_info* filt = add_new_filter(rar);
2303 archive_set_error(&ar->archive, ENOMEM, "Can't allocate memory for a "
2304 "filter descriptor.");
2305 return ARCHIVE_FATAL;
2308 filt->type = filter_type;
2309 filt->block_start = rar->cstate.write_ptr + block_start;
2310 filt->block_length = block_length;
2312 rar->cstate.last_block_start = filt->block_start;
2313 rar->cstate.last_block_length = filt->block_length;
2315 /* Read some more data in case this is a DELTA filter. Other filter types
2316 * don't require any additional data over what was already read. */
2317 if(filter_type == FILTER_DELTA) {
2320 if(ARCHIVE_OK != read_consume_bits(rar, p, 5, &channels))
2323 filt->channels = channels + 1;
2329 static int decode_code_length(struct rar5* rar, const uint8_t* p,
2332 int lbits, length = 2;
2337 lbits = code / 4 - 1;
2338 length += (4 | (code & 3)) << lbits;
2344 if(ARCHIVE_OK != read_consume_bits(rar, p, lbits, &add))
2353 static int copy_string(struct archive_read* a, int len, int dist) {
2354 struct rar5* rar = get_context(a);
2355 const int cmask = (int)rar->cstate.window_mask;
2356 const int64_t write_ptr = rar->cstate.write_ptr + rar->cstate.solid_offset;
2359 /* The unpacker spends most of the time in this function. It would be
2360 * a good idea to introduce some optimizations here.
2362 * Just remember that this loop treats buffers that overlap differently
2363 * than buffers that do not overlap. This is why a simple memcpy(3) call
2364 * will not be enough. */
2366 for(i = 0; i < len; i++) {
2367 const ssize_t write_idx = (write_ptr + i) & cmask;
2368 const ssize_t read_idx = (write_ptr + i - dist) & cmask;
2369 rar->cstate.window_buf[write_idx] = rar->cstate.window_buf[read_idx];
2372 rar->cstate.write_ptr += len;
2376 static int do_uncompress_block(struct archive_read* a, const uint8_t* p) {
2377 struct rar5* rar = get_context(a);
2381 const int cmask = (int)rar->cstate.window_mask;
2382 const struct compressed_block_header* hdr = &rar->last_block_hdr;
2383 const uint8_t bit_size = 1 + hdr->block_flags.bit_size;
2386 if(rar->cstate.write_ptr - rar->cstate.last_write_ptr >
2387 (rar->cstate.window_size >> 1)) {
2389 /* Don't allow growing data by more than half of the window size
2390 * at a time. In such case, break the loop; next call to this
2391 * function will continue processing from this moment. */
2396 if(rar->bits.in_addr > rar->cstate.cur_block_size - 1 ||
2397 (rar->bits.in_addr == rar->cstate.cur_block_size - 1 &&
2398 rar->bits.bit_addr >= bit_size))
2400 /* If the program counter is here, it means the function has
2401 * finished processing the block. */
2402 rar->cstate.block_parsing_finished = 1;
2406 /* Decode the next literal. */
2407 if(ARCHIVE_OK != decode_number(a, &rar->cstate.ld, p, &num)) {
2411 /* Num holds a decompression literal, or 'command code'.
2413 * - Values lower than 256 are just bytes. Those codes can be stored
2414 * in the output buffer directly.
2416 * - Code 256 defines a new filter, which is later used to transform
2417 * the data block accordingly to the filter type. The data block
2418 * needs to be fully uncompressed first.
2420 * - Code bigger than 257 and smaller than 262 define a repetition
2421 * pattern that should be copied from an already uncompressed chunk
2426 /* Directly store the byte. */
2428 int64_t write_idx = rar->cstate.solid_offset +
2429 rar->cstate.write_ptr++;
2431 rar->cstate.window_buf[write_idx & cmask] = (uint8_t) num;
2433 } else if(num >= 262) {
2435 int len = decode_code_length(rar, p, num - 262),
2440 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
2441 "Failed to decode the code length");
2443 return ARCHIVE_FATAL;
2446 if(ARCHIVE_OK != decode_number(a, &rar->cstate.dd, p, &dist_slot))
2448 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
2449 "Failed to decode the distance slot");
2451 return ARCHIVE_FATAL;
2458 dbits = dist_slot / 2 - 1;
2459 dist += (2 | (dist_slot & 1)) << dbits;
2468 if(ARCHIVE_OK != read_bits_32(rar, p, &add)) {
2469 /* Return EOF if we can't read more data. */
2473 skip_bits(rar, dbits - 4);
2474 add = (add >> (36 - dbits)) << 4;
2478 if(ARCHIVE_OK != decode_number(a, &rar->cstate.ldd, p,
2481 archive_set_error(&a->archive,
2482 ARCHIVE_ERRNO_PROGRAMMER,
2483 "Failed to decode the distance slot");
2485 return ARCHIVE_FATAL;
2490 /* dbits is one of [0,1,2,3] */
2493 if(ARCHIVE_OK != read_consume_bits(rar, p, dbits, &add)) {
2494 /* Return EOF if we can't read more data. */
2508 if(dist > 0x40000) {
2514 dist_cache_push(rar, dist);
2515 rar->cstate.last_len = len;
2517 if(ARCHIVE_OK != copy_string(a, len, dist))
2518 return ARCHIVE_FATAL;
2521 } else if(num == 256) {
2522 /* Create a filter. */
2523 ret = parse_filter(a, p);
2524 if(ret != ARCHIVE_OK)
2528 } else if(num == 257) {
2529 if(rar->cstate.last_len != 0) {
2530 if(ARCHIVE_OK != copy_string(a, rar->cstate.last_len,
2531 rar->cstate.dist_cache[0]))
2533 return ARCHIVE_FATAL;
2538 } else if(num < 262) {
2539 const int index = num - 258;
2540 const int dist = dist_cache_touch(rar, index);
2545 if(ARCHIVE_OK != decode_number(a, &rar->cstate.rd, p, &len_slot)) {
2546 return ARCHIVE_FATAL;
2549 len = decode_code_length(rar, p, len_slot);
2550 rar->cstate.last_len = len;
2552 if(ARCHIVE_OK != copy_string(a, len, dist))
2553 return ARCHIVE_FATAL;
2558 /* The program counter shouldn't reach here. */
2559 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2560 "Unsupported block code: 0x%02x", num);
2562 return ARCHIVE_FATAL;
2568 /* Binary search for the RARv5 signature. */
2569 static int scan_for_signature(struct archive_read* a) {
2571 const int chunk_size = 512;
2574 /* If we're here, it means we're on an 'unknown territory' data.
2575 * There's no indication what kind of data we're reading here. It could be
2576 * some text comment, any kind of binary data, digital sign, dragons, etc.
2578 * We want to find a valid RARv5 magic header inside this unknown data. */
2580 /* Is it possible in libarchive to just skip everything until the
2581 * end of the file? If so, it would be a better approach than the
2582 * current implementation of this function. */
2585 if(!read_ahead(a, chunk_size, &p))
2588 for(i = 0; i < chunk_size - rar5_signature_size; i++) {
2589 if(memcmp(&p[i], rar5_signature, rar5_signature_size) == 0) {
2590 /* Consume the number of bytes we've used to search for the
2591 * signature, as well as the number of bytes used by the
2592 * signature itself. After this we should be standing on a
2593 * valid base block header. */
2594 (void) consume(a, i + rar5_signature_size);
2599 consume(a, chunk_size);
2602 return ARCHIVE_FATAL;
2605 /* This function will switch the multivolume archive file to another file,
2606 * i.e. from part03 to part 04. */
2607 static int advance_multivolume(struct archive_read* a) {
2609 struct rar5* rar = get_context(a);
2611 /* A small state machine that will skip unnecessary data, needed to
2612 * switch from one multivolume to another. Such skipping is needed if
2613 * we want to be an stream-oriented (instead of file-oriented)
2616 * The state machine starts with `rar->main.endarc` == 0. It also
2617 * assumes that current stream pointer points to some base block header.
2619 * The `endarc` field is being set when the base block parsing function
2620 * encounters the 'end of archive' marker.
2624 if(rar->main.endarc == 1) {
2625 rar->main.endarc = 0;
2626 while(ARCHIVE_RETRY == skip_base_block(a));
2629 /* Skip current base block. In order to properly skip it,
2630 * we really need to simply parse it and discard the results. */
2632 lret = skip_base_block(a);
2634 /* The `skip_base_block` function tells us if we should continue
2635 * with skipping, or we should stop skipping. We're trying to skip
2636 * everything up to a base FILE block. */
2638 if(lret != ARCHIVE_RETRY) {
2639 /* If there was an error during skipping, or we have just
2640 * skipped a FILE base block... */
2642 if(rar->main.endarc == 0) {
2654 /* Merges the partial block from the first multivolume archive file, and
2655 * partial block from the second multivolume archive file. The result is
2656 * a chunk of memory containing the whole block, and the stream pointer
2657 * is advanced to the next block in the second multivolume archive file. */
2658 static int merge_block(struct archive_read* a, ssize_t block_size,
2661 struct rar5* rar = get_context(a);
2662 ssize_t cur_block_size, partial_offset = 0;
2666 /* Set a flag that we're in the switching mode. */
2667 rar->cstate.switch_multivolume = 1;
2669 /* Reallocate the memory which will hold the whole block. */
2670 if(rar->vol.push_buf)
2671 free((void*) rar->vol.push_buf);
2673 /* Increasing the allocation block by 8 is due to bit reading functions,
2674 * which are using additional 2 or 4 bytes. Allocating the block size
2675 * by exact value would make bit reader perform reads from invalid memory
2676 * block when reading the last byte from the buffer. */
2677 rar->vol.push_buf = malloc(block_size + 8);
2678 if(!rar->vol.push_buf) {
2679 archive_set_error(&a->archive, ENOMEM, "Can't allocate memory for a "
2680 "merge block buffer.");
2681 return ARCHIVE_FATAL;
2684 /* Valgrind complains if the extension block for bit reader is not
2685 * initialized, so initialize it. */
2686 memset(&rar->vol.push_buf[block_size], 0, 8);
2688 /* A single block can span across multiple multivolume archive files,
2689 * so we use a loop here. This loop will consume enough multivolume
2690 * archive files until the whole block is read. */
2693 /* Get the size of current block chunk in this multivolume archive
2694 * file and read it. */
2696 rar5_min(rar->file.bytes_remaining, block_size - partial_offset);
2698 if(!read_ahead(a, cur_block_size, &lp))
2701 /* Sanity check; there should never be a situation where this function
2702 * reads more data than the block's size. */
2703 if(partial_offset + cur_block_size > block_size) {
2704 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
2705 "Consumed too much data when merging blocks.");
2706 return ARCHIVE_FATAL;
2709 /* Merge previous block chunk with current block chunk, or create
2710 * first block chunk if this is our first iteration. */
2711 memcpy(&rar->vol.push_buf[partial_offset], lp, cur_block_size);
2713 /* Advance the stream read pointer by this block chunk size. */
2714 if(ARCHIVE_OK != consume(a, cur_block_size))
2717 /* Update the pointers. `partial_offset` contains information about
2718 * the sum of merged block chunks. */
2719 partial_offset += cur_block_size;
2720 rar->file.bytes_remaining -= cur_block_size;
2722 /* If `partial_offset` is the same as `block_size`, this means we've
2723 * merged all block chunks and we have a valid full block. */
2724 if(partial_offset == block_size) {
2728 /* If we don't have any bytes to read, this means we should switch
2729 * to another multivolume archive file. */
2730 if(rar->file.bytes_remaining == 0) {
2731 ret = advance_multivolume(a);
2732 if(ret != ARCHIVE_OK)
2737 *p = rar->vol.push_buf;
2739 /* If we're here, we can resume unpacking by processing the block pointed
2740 * to by the `*p` memory pointer. */
2745 static int process_block(struct archive_read* a) {
2747 struct rar5* rar = get_context(a);
2750 /* If we don't have any data to be processed, this most probably means
2751 * we need to switch to the next volume. */
2752 if(rar->main.volume && rar->file.bytes_remaining == 0) {
2753 ret = advance_multivolume(a);
2754 if(ret != ARCHIVE_OK)
2758 if(rar->cstate.block_parsing_finished) {
2761 rar->cstate.block_parsing_finished = 0;
2763 /* The header size won't be bigger than 6 bytes. */
2764 if(!read_ahead(a, 6, &p)) {
2765 /* Failed to prefetch data block header. */
2770 * Read block_size by parsing block header. Validate the header by
2771 * calculating CRC byte stored inside the header. Size of the header is
2772 * not constant (block size can be stored either in 1 or 2 bytes),
2773 * that's why block size is left out from the `compressed_block_header`
2774 * structure and returned by `parse_block_header` as the second
2777 ret = parse_block_header(a, p, &block_size, &rar->last_block_hdr);
2778 if(ret != ARCHIVE_OK)
2781 /* Skip block header. Next data is huffman tables, if present. */
2782 ssize_t to_skip = sizeof(struct compressed_block_header) +
2783 rar->last_block_hdr.block_flags.byte_count + 1;
2785 if(ARCHIVE_OK != consume(a, to_skip))
2788 rar->file.bytes_remaining -= to_skip;
2790 /* The block size gives information about the whole block size, but
2791 * the block could be stored in split form when using multi-volume
2792 * archives. In this case, the block size will be bigger than the
2793 * actual data stored in this file. Remaining part of the data will
2794 * be in another file. */
2796 ssize_t cur_block_size =
2797 rar5_min(rar->file.bytes_remaining, block_size);
2799 if(block_size > rar->file.bytes_remaining) {
2800 /* If current blocks' size is bigger than our data size, this
2801 * means we have a multivolume archive. In this case, skip
2802 * all base headers until the end of the file, proceed to next
2803 * "partXXX.rar" volume, find its signature, skip all headers up
2804 * to the first FILE base header, and continue from there.
2806 * Note that `merge_block` will update the `rar` context structure
2807 * quite extensively. */
2809 ret = merge_block(a, block_size, &p);
2810 if(ret != ARCHIVE_OK) {
2814 cur_block_size = block_size;
2816 /* Current stream pointer should be now directly *after* the
2817 * block that spanned through multiple archive files. `p` pointer
2818 * should have the data of the *whole* block (merged from
2819 * partial blocks stored in multiple archives files). */
2821 rar->cstate.switch_multivolume = 0;
2823 /* Read the whole block size into memory. This can take up to
2824 * 8 megabytes of memory in theoretical cases. Might be worth to
2825 * optimize this and use a standard chunk of 4kb's. */
2827 if(!read_ahead(a, 4 + cur_block_size, &p)) {
2828 /* Failed to prefetch block data. */
2833 rar->cstate.block_buf = p;
2834 rar->cstate.cur_block_size = cur_block_size;
2836 rar->bits.in_addr = 0;
2837 rar->bits.bit_addr = 0;
2839 if(rar->last_block_hdr.block_flags.is_table_present) {
2840 /* Load Huffman tables. */
2841 ret = parse_tables(a, rar, p);
2842 if(ret != ARCHIVE_OK) {
2843 /* Error during decompression of Huffman tables. */
2848 p = rar->cstate.block_buf;
2851 /* Uncompress the block, or a part of it, depending on how many bytes
2852 * will be generated by uncompressing the block.
2854 * In case too many bytes will be generated, calling this function again
2855 * will resume the uncompression operation. */
2856 ret = do_uncompress_block(a, p);
2857 if(ret != ARCHIVE_OK) {
2861 if(rar->cstate.block_parsing_finished &&
2862 rar->cstate.switch_multivolume == 0 &&
2863 rar->cstate.cur_block_size > 0)
2865 /* If we're processing a normal block, consume the whole block. We
2866 * can do this because we've already read the whole block to memory.
2868 if(ARCHIVE_OK != consume(a, rar->cstate.cur_block_size))
2869 return ARCHIVE_FATAL;
2871 rar->file.bytes_remaining -= rar->cstate.cur_block_size;
2872 } else if(rar->cstate.switch_multivolume) {
2873 /* Don't consume the block if we're doing multivolume processing.
2874 * The volume switching function will consume the proper count of
2877 rar->cstate.switch_multivolume = 0;
2883 /* Pops the `buf`, `size` and `offset` from the "data ready" stack.
2885 * Returns ARCHIVE_OK when those arguments can be used, ARCHIVE_RETRY
2886 * when there is no data on the stack. */
2887 static int use_data(struct rar5* rar, const void** buf, size_t* size,
2892 for(i = 0; i < rar5_countof(rar->cstate.dready); i++) {
2893 struct data_ready *d = &rar->cstate.dready[i];
2896 if(buf) *buf = d->buf;
2897 if(size) *size = d->size;
2898 if(offset) *offset = d->offset;
2905 return ARCHIVE_RETRY;
2908 /* Pushes the `buf`, `size` and `offset` arguments to the rar->cstate.dready
2909 * FIFO stack. Those values will be popped from this stack by the `use_data`
2911 static int push_data_ready(struct archive_read* a, struct rar5* rar,
2912 const uint8_t* buf, size_t size, int64_t offset)
2916 /* Don't push if we're in skip mode. This is needed because solid
2917 * streams need full processing even if we're skipping data. After fully
2918 * processing the stream, we need to discard the generated bytes, because
2919 * we're interested only in the side effect: building up the internal
2920 * window circular buffer. This window buffer will be used later during
2921 * unpacking of requested data. */
2926 if(offset != rar->file.last_offset + rar->file.last_size) {
2927 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER, "Sanity "
2928 "check error: output stream is not continuous");
2929 return ARCHIVE_FATAL;
2932 for(i = 0; i < rar5_countof(rar->cstate.dready); i++) {
2933 struct data_ready* d = &rar->cstate.dready[i];
2940 /* These fields are used only in sanity checking. */
2941 rar->file.last_offset = offset;
2942 rar->file.last_size = size;
2944 /* Calculate the checksum of this new block before submitting
2945 * data to libarchive's engine. */
2946 update_crc(rar, d->buf, d->size);
2952 /* Program counter will reach this code if the `rar->cstate.data_ready`
2953 * stack will be filled up so that no new entries will be allowed. The
2954 * code shouldn't allow such situation to occur. So we treat this case
2955 * as an internal error. */
2957 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER, "Error: "
2958 "premature end of data_ready stack");
2959 return ARCHIVE_FATAL;
2962 /* This function uncompresses the data that is stored in the <FILE> base
2965 * The FILE base block looks like this:
2967 * <header><huffman tables><block_1><block_2>...<block_n>
2969 * The <header> is a block header, that is parsed in parse_block_header().
2970 * It's a "compressed_block_header" structure, containing metadata needed
2971 * to know when we should stop looking for more <block_n> blocks.
2973 * <huffman tables> contain data needed to set up the huffman tables, needed
2974 * for the actual decompression.
2976 * Each <block_n> consists of series of literals:
2978 * <literal><literal><literal>...<literal>
2980 * Those literals generate the uncompression data. They operate on a circular
2981 * buffer, sometimes writing raw data into it, sometimes referencing
2982 * some previous data inside this buffer, and sometimes declaring a filter
2983 * that will need to be executed on the data stored in the circular buffer.
2984 * It all depends on the literal that is used.
2986 * Sometimes blocks produce output data, sometimes they don't. For example, for
2987 * some huge files that use lots of filters, sometimes a block is filled with
2988 * only filter declaration literals. Such blocks won't produce any data in the
2991 * Sometimes blocks will produce 4 bytes of data, and sometimes 1 megabyte,
2992 * because a literal can reference previously decompressed data. For example,
2993 * there can be a literal that says: 'append a byte 0xFE here', and after
2994 * it another literal can say 'append 1 megabyte of data from circular buffer
2995 * offset 0x12345'. This is how RAR format handles compressing repeated
2998 * The RAR compressor creates those literals and the actual efficiency of
2999 * compression depends on what those literals are. The literals can also
3000 * be seen as a kind of a non-turing-complete virtual machine that simply
3001 * tells the decompressor what it should do.
3004 static int do_uncompress_file(struct archive_read* a) {
3005 struct rar5* rar = get_context(a);
3007 int64_t max_end_pos;
3009 if(!rar->cstate.initialized) {
3010 /* Don't perform full context reinitialization if we're processing
3011 * a solid archive. */
3012 if(!rar->main.solid || !rar->cstate.window_buf) {
3016 rar->cstate.initialized = 1;
3019 if(rar->cstate.all_filters_applied == 1) {
3020 /* We use while(1) here, but standard case allows for just 1 iteration.
3021 * The loop will iterate if process_block() didn't generate any data at
3022 * all. This can happen if the block contains only filter definitions
3023 * (this is common in big files). */
3026 ret = process_block(a);
3027 if(ret == ARCHIVE_EOF || ret == ARCHIVE_FATAL)
3030 if(rar->cstate.last_write_ptr == rar->cstate.write_ptr) {
3031 /* The block didn't generate any new data, so just process
3036 /* The block has generated some new data, so break the loop. */
3041 /* Try to run filters. If filters won't be applied, it means that
3042 * insufficient data was generated. */
3043 ret = apply_filters(a);
3044 if(ret == ARCHIVE_RETRY) {
3046 } else if(ret == ARCHIVE_FATAL) {
3047 return ARCHIVE_FATAL;
3050 /* If apply_filters() will return ARCHIVE_OK, we can continue here. */
3052 if(cdeque_size(&rar->cstate.filters) > 0) {
3053 /* Check if we can write something before hitting first filter. */
3054 struct filter_info* flt;
3056 /* Get the block_start offset from the first filter. */
3057 if(CDE_OK != cdeque_front(&rar->cstate.filters, cdeque_filter_p(&flt)))
3059 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
3060 "Can't read first filter");
3061 return ARCHIVE_FATAL;
3064 max_end_pos = rar5_min(flt->block_start, rar->cstate.write_ptr);
3066 /* There are no filters defined, or all filters were applied. This
3067 * means we can just store the data without any postprocessing. */
3068 max_end_pos = rar->cstate.write_ptr;
3071 if(max_end_pos == rar->cstate.last_write_ptr) {
3072 /* We can't write anything yet. The block uncompression function did
3073 * not generate enough data, and no filter can be applied. At the same
3074 * time we don't have any data that can be stored without filter
3075 * postprocessing. This means we need to wait for more data to be
3076 * generated, so we can apply the filters.
3078 * Signal the caller that we need more data to be able to do anything.
3080 return ARCHIVE_RETRY;
3082 /* We can write the data before hitting the first filter. So let's
3083 * do it. The push_window_data() function will effectively return
3084 * the selected data block to the user application. */
3085 push_window_data(a, rar, rar->cstate.last_write_ptr, max_end_pos);
3086 rar->cstate.last_write_ptr = max_end_pos;
3092 static int uncompress_file(struct archive_read* a) {
3096 /* Sometimes the uncompression function will return a 'retry' signal.
3097 * If this will happen, we have to retry the function. */
3098 ret = do_uncompress_file(a);
3099 if(ret != ARCHIVE_RETRY)
3105 static int do_unstore_file(struct archive_read* a,
3113 if(rar->file.bytes_remaining == 0 && rar->main.volume > 0 &&
3114 rar->generic.split_after > 0)
3118 rar->cstate.switch_multivolume = 1;
3119 ret = advance_multivolume(a);
3120 rar->cstate.switch_multivolume = 0;
3122 if(ret != ARCHIVE_OK) {
3123 /* Failed to advance to next multivolume archive file. */
3128 size_t to_read = rar5_min(rar->file.bytes_remaining, 64 * 1024);
3130 if(!read_ahead(a, to_read, &p)) {
3131 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT, "I/O error "
3132 "when unstoring file");
3133 return ARCHIVE_FATAL;
3136 if(ARCHIVE_OK != consume(a, to_read)) {
3141 if(size) *size = to_read;
3142 if(offset) *offset = rar->cstate.last_unstore_ptr;
3144 rar->file.bytes_remaining -= to_read;
3145 rar->cstate.last_unstore_ptr += to_read;
3147 update_crc(rar, p, to_read);
3151 static int do_unpack(struct archive_read* a, struct rar5* rar,
3152 const void** buf, size_t* size, int64_t* offset)
3154 enum COMPRESSION_METHOD {
3155 STORE = 0, FASTEST = 1, FAST = 2, NORMAL = 3, GOOD = 4, BEST = 5
3158 if(rar->file.service > 0) {
3159 return do_unstore_file(a, rar, buf, size, offset);
3161 switch(rar->cstate.method) {
3163 return do_unstore_file(a, rar, buf, size, offset);
3173 return uncompress_file(a);
3175 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
3176 "Compression method not supported: 0x%08x",
3177 rar->cstate.method);
3179 return ARCHIVE_FATAL;
3189 static int verify_checksums(struct archive_read* a) {
3191 struct rar5* rar = get_context(a);
3193 /* Check checksums only when actually unpacking the data. There's no need
3194 * to calculate checksum when we're skipping data in solid archives
3195 * (skipping in solid archives is the same thing as unpacking compressed
3196 * data and discarding the result). */
3198 if(!rar->skip_mode) {
3199 /* Always check checkums if we're not in skip mode */
3202 /* We can override the logic above with a compile-time option
3203 * NO_CRC_ON_SOLID_SKIP. This option is used during debugging, and it
3204 * will check checksums of unpacked data even when we're skipping it.
3207 #if defined CHECK_CRC_ON_SOLID_SKIP
3217 /* During unpacking, on each unpacked block we're calling the
3218 * update_crc() function. Since we are here, the unpacking process is
3219 * already over and we can check if calculated checksum (CRC32 or
3220 * BLAKE2sp) is the same as what is stored in the archive.
3222 if(rar->file.stored_crc32 > 0) {
3223 /* Check CRC32 only when the file contains a CRC32 value for this
3226 if(rar->file.calculated_crc32 != rar->file.stored_crc32) {
3227 /* Checksums do not match; the unpacked file is corrupted. */
3230 printf("Checksum error: CRC32 (was: %08x, expected: %08x)\n",
3231 rar->file.calculated_crc32, rar->file.stored_crc32);
3234 #ifndef DONT_FAIL_ON_CRC_ERROR
3235 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
3236 "Checksum error: CRC32");
3237 return ARCHIVE_FATAL;
3241 printf("Checksum OK: CRC32 (%08x/%08x)\n",
3242 rar->file.stored_crc32,
3243 rar->file.calculated_crc32);
3248 if(rar->file.has_blake2 > 0) {
3249 /* BLAKE2sp is an optional checksum algorithm that is added to
3250 * RARv5 archives when using the `-htb` switch during creation of
3253 * We now finalize the hash calculation by calling the `final`
3254 * function. This will generate the final hash value we can use to
3255 * compare it with the BLAKE2sp checksum that is stored in the
3258 * The return value of this `final` function is not very helpful,
3259 * as it guards only against improper use. This is why we're
3260 * explicitly ignoring it. */
3263 (void) blake2sp_final(&rar->file.b2state, b2_buf, 32);
3265 if(memcmp(&rar->file.blake2sp, b2_buf, 32) != 0) {
3266 #ifndef DONT_FAIL_ON_CRC_ERROR
3267 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
3268 "Checksum error: BLAKE2");
3270 return ARCHIVE_FATAL;
3276 /* Finalization for this file has been successfully completed. */
3280 static int verify_global_checksums(struct archive_read* a) {
3281 return verify_checksums(a);
3284 static int rar5_read_data(struct archive_read *a, const void **buff,
3285 size_t *size, int64_t *offset) {
3287 struct rar5* rar = get_context(a);
3289 if(!rar->skip_mode && (rar->cstate.last_write_ptr > rar->file.unpacked_size)) {
3290 archive_set_error(&a->archive, ARCHIVE_ERRNO_PROGRAMMER,
3291 "Unpacker has written too many bytes");
3292 return ARCHIVE_FATAL;
3295 ret = use_data(rar, buff, size, offset);
3296 if(ret == ARCHIVE_OK)
3299 ret = do_unpack(a, rar, buff, size, offset);
3300 if(ret != ARCHIVE_OK) {
3304 if(rar->file.bytes_remaining == 0 &&
3305 rar->cstate.last_write_ptr == rar->file.unpacked_size)
3307 /* If all bytes of current file were processed, run finalization.
3309 * Finalization will check checksum against proper values. If
3310 * some of the checksums will not match, we'll return an error
3311 * value in the last `archive_read_data` call to signal an error
3314 return verify_global_checksums(a);
3320 static int rar5_read_data_skip(struct archive_read *a) {
3321 struct rar5* rar = get_context(a);
3323 if(rar->main.solid) {
3324 /* In solid archives, instead of skipping the data, we need to extract
3325 * it, and dispose the result. The side effect of this operation will
3326 * be setting up the initial window buffer state needed to be able to
3327 * extract the selected file. */
3331 /* Make sure to process all blocks in the compressed stream. */
3332 while(rar->file.bytes_remaining > 0) {
3333 /* Setting the "skip mode" will allow us to skip checksum checks
3334 * during data skipping. Checking the checksum of skipped data
3335 * isn't really necessary and it's only slowing things down.
3337 * This is incremented instead of setting to 1 because this data
3338 * skipping function can be called recursively. */
3341 /* We're disposing 1 block of data, so we use triple NULLs in
3344 ret = rar5_read_data(a, NULL, NULL, NULL);
3346 /* Turn off "skip mode". */
3350 /* Propagate any potential error conditions to the caller. */
3355 /* In standard archives, we can just jump over the compressed stream.
3356 * Each file in non-solid archives starts from an empty window buffer.
3359 if(ARCHIVE_OK != consume(a, rar->file.bytes_remaining)) {
3360 return ARCHIVE_FATAL;
3363 rar->file.bytes_remaining = 0;
3369 static int64_t rar5_seek_data(struct archive_read *a, int64_t offset,
3376 /* We're a streaming unpacker, and we don't support seeking. */
3378 return ARCHIVE_FATAL;
3381 static int rar5_cleanup(struct archive_read *a) {
3382 struct rar5* rar = get_context(a);
3384 free(rar->cstate.window_buf);
3386 free(rar->cstate.filtered_buf);
3388 free(rar->vol.push_buf);
3391 cdeque_free(&rar->cstate.filters);
3394 a->format->data = NULL;
3399 static int rar5_capabilities(struct archive_read * a) {
3404 static int rar5_has_encrypted_entries(struct archive_read *_a) {
3407 /* Unsupported for now. */
3408 return ARCHIVE_READ_FORMAT_ENCRYPTION_UNSUPPORTED;
3411 static int rar5_init(struct rar5* rar) {
3414 memset(rar, 0, sizeof(struct rar5));
3416 /* Decrypt the magic signature pattern. Check the comment near the
3417 * `rar5_signature` symbol to read the rationale behind this. */
3419 if(rar5_signature[0] == 243) {
3420 for(i = 0; i < rar5_signature_size; i++) {
3421 rar5_signature[i] ^= 0xA1;
3425 if(CDE_OK != cdeque_init(&rar->cstate.filters, 8192))
3426 return ARCHIVE_FATAL;
3431 int archive_read_support_format_rar5(struct archive *_a) {
3432 struct archive_read* ar;
3436 if(ARCHIVE_OK != (ret = get_archive_read(_a, &ar)))
3439 rar = malloc(sizeof(*rar));
3441 archive_set_error(&ar->archive, ENOMEM, "Can't allocate rar5 data");
3442 return ARCHIVE_FATAL;
3445 if(ARCHIVE_OK != rar5_init(rar)) {
3446 archive_set_error(&ar->archive, ENOMEM, "Can't allocate rar5 filter "
3448 return ARCHIVE_FATAL;
3451 ret = __archive_read_register_format(ar,
3458 rar5_read_data_skip,
3462 rar5_has_encrypted_entries);
3464 if(ret != ARCHIVE_OK) {
3465 (void) rar5_cleanup(ar);