├── .gitignore ├── LICENSE ├── Makefile ├── README ├── test ├── archives │ ├── tar_test_primitive.tar │ ├── tar_test_primitive │ │ ├── PRIM_FILE_1.txt │ │ ├── PRIM_FILE_2.txt │ │ └── PRIM_README.txt │ ├── tar_test_ustar.tar │ └── tar_test_ustar │ │ ├── PRIM_FILE_1.txt │ │ ├── PRIM_FILE_2.txt │ │ ├── PRIM_FILE_HARD.txt │ │ ├── PRIM_FILE_SYM.txt │ │ └── PRIM_README.txt └── main.c └── tinyuntar ├── untar.c └── untar.h /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | A tiny untar library written in C. 294 | Copyright (C) 2013 Dustin Oprea 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | all: example 2 | 3 | build/untar.o: tinyuntar/untar.c 4 | mkdir -p build 5 | gcc -c -o build/untar.o tinyuntar/untar.c 6 | 7 | example: build/untar.o test/main.c 8 | mkdir -p build 9 | gcc -g -I tinyuntar -o build/untar build/untar.o test/main.c -lm 10 | 11 | clean: 12 | rm -fr build 13 | 14 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | Introduction 2 | ============ 3 | 4 | This is a very small untar (TAR archive reader) utility written in C. It's 5 | meant to be embedded within code. I wrote this because the only other option 6 | seemed to be zlib, which was overkill. There are no library dependencies 7 | other than the "math" library (for some standard math calls). 8 | 9 | 10 | How it Works 11 | ============ 12 | 13 | You pass three callbacks to the read_tar() routine: 14 | 15 | Header callback 16 | 17 | Receives a header struct, and an entry index. 18 | 19 | Identifies the beginning of a file. This callback is always invoked before 20 | the other two. 21 | 22 | Data callback 23 | 24 | Receives a header struct, entry index, a block of data, and the length of 25 | the block. 26 | 27 | Called one or more times for each block of data. This callback is always 28 | invoked after the header callback, and before the end callback. 29 | 30 | End callback: 31 | 32 | Receives a header struct, and an entry index. 33 | 34 | This callback is always invoked after all of the data for an entry has been 35 | reported. 36 | 37 | 38 | Running the Example 39 | ================== 40 | 41 | 1) Run 'make'. 42 | 2) Run 'build/untar ' 43 | 44 | The example will expand all normal (non-links, non-special, non-directory..) 45 | entries into /tmp. It will not create directories, so you'll have to create the 46 | directories mentioned in the "can't write" error messages. 47 | 48 | 49 | Notes 50 | ===== 51 | 52 | This utility supports both the primitive and USTAR formats (this should be a 53 | majority of the TAR files), but none of the vendor-specific formats that may 54 | exist. I wrote it according to the specifications that I had available. 55 | 56 | If a TAR file isn't being successfully read, submit a bug and I'll try to adopt 57 | it, if there's a simple fix. 58 | 59 | -------------------------------------------------------------------------------- /test/archives/tar_test_primitive.tar: -------------------------------------------------------------------------------- 1 | tar_test_primitive/ 40777 0 0 0 12205027150 10004 5tar_test_primitive/PRIM_FILE_1.txt100777 0 0 14 12205027100 12361 0Test file 1.tar_test_primitive/PRIM_FILE_2.txt100777 0 0 14 12205027116 12371 0Test file 2.tar_test_primitive/PRIM_README.txt100777 0 0 135 12205027146 12415 0This archive was created by 7-Zip under Windows, which uses the old TAR format (non-ustar). 2 | -------------------------------------------------------------------------------- /test/archives/tar_test_primitive/PRIM_FILE_1.txt: -------------------------------------------------------------------------------- 1 | Test file 1. -------------------------------------------------------------------------------- /test/archives/tar_test_primitive/PRIM_FILE_2.txt: -------------------------------------------------------------------------------- 1 | Test file 2. -------------------------------------------------------------------------------- /test/archives/tar_test_primitive/PRIM_README.txt: -------------------------------------------------------------------------------- 1 | This archive was created by 7-Zip under Windows, which uses the old TAR format (non-ustar). 2 | -------------------------------------------------------------------------------- /test/archives/tar_test_ustar.tar: -------------------------------------------------------------------------------- 1 | tar_test_ustar/0000775000175000017500000000000012205030735013516 5ustar dustindustintar_test_ustar/PRIM_FILE_2.txt0000664000175000017500000000001412205027116016040 0ustar dustindustinTest file 2.tar_test_ustar/PRIM_FILE_SYM.txt0000777000175000017500000000000012205030546020700 2PRIM_FILE_2.txtustar dustindustintar_test_ustar/PRIM_FILE_HARD.txt0000664000175000017500000000000012205027116024002 1tar_test_ustar/PRIM_FILE_2.txtustar dustindustintar_test_ustar/PRIM_FILE_1.txt0000664000175000017500000000001412205027100016030 0ustar dustindustinTest file 1.tar_test_ustar/PRIM_README.txt0000664000175000017500000000022212205030735016037 0ustar dustindustinThis archive was created by TAR under Linux, which uses the USTAR-TAR format. It also shows how this format can describe device files and links. 2 | dev/random0000666000000000000000000000000012145764526013010 3ustar rootroot00000010000010 -------------------------------------------------------------------------------- /test/archives/tar_test_ustar/PRIM_FILE_1.txt: -------------------------------------------------------------------------------- 1 | Test file 1. -------------------------------------------------------------------------------- /test/archives/tar_test_ustar/PRIM_FILE_2.txt: -------------------------------------------------------------------------------- 1 | Test file 2. -------------------------------------------------------------------------------- /test/archives/tar_test_ustar/PRIM_FILE_HARD.txt: -------------------------------------------------------------------------------- 1 | Test file 2. -------------------------------------------------------------------------------- /test/archives/tar_test_ustar/PRIM_FILE_SYM.txt: -------------------------------------------------------------------------------- 1 | PRIM_FILE_2.txt -------------------------------------------------------------------------------- /test/archives/tar_test_ustar/PRIM_README.txt: -------------------------------------------------------------------------------- 1 | This archive was created by TAR under Linux, which uses the USTAR-TAR format. It also shows how this format can describe device files and links. 2 | -------------------------------------------------------------------------------- /test/main.c: -------------------------------------------------------------------------------- 1 | #include 2 | 3 | #include "untar.h" 4 | 5 | FILE *fp_writer = NULL; 6 | 7 | int entry_header_cb(header_translated_t *proper, 8 | int entry_index, 9 | void *context_data) 10 | { 11 | dump_header(proper); 12 | 13 | if(proper->type == T_NORMAL) 14 | { 15 | char file_path[256] = ""; 16 | strcat(file_path, "/tmp/"); 17 | strcat(file_path, proper->filename); 18 | 19 | if((fp_writer = fopen(file_path, "wb")) == NULL) 20 | { 21 | printf("Could not open [%s] for write.\n", file_path); 22 | return -1; 23 | } 24 | } 25 | else 26 | printf("Not writing non-normal file.\n\n"); 27 | 28 | return 0; 29 | } 30 | 31 | int entry_data_cb(header_translated_t *proper, 32 | int entry_index, 33 | void *context_data, 34 | unsigned char *block, 35 | int length) 36 | { 37 | if(fp_writer != NULL) 38 | fwrite(block, length, 1, fp_writer); 39 | 40 | return 0; 41 | } 42 | 43 | int entry_end_cb(header_translated_t *proper, 44 | int entry_index, 45 | void *context_data) 46 | { 47 | if(fp_writer != NULL) 48 | { 49 | fclose(fp_writer); 50 | fp_writer = NULL; 51 | } 52 | 53 | return 0; 54 | } 55 | 56 | int main(int argc, const char* argv[]) 57 | { 58 | entry_callbacks_t entry_callbacks = { entry_header_cb, 59 | entry_data_cb, 60 | entry_end_cb }; 61 | 62 | if(argc < 2) 63 | { 64 | printf("Please provide the file-path of a TAR file.\n\n"); 65 | return -1; 66 | } 67 | 68 | if(read_tar(argv[1], &entry_callbacks, NULL) != 0) 69 | { 70 | printf("Read failed.\n\n"); 71 | return -2; 72 | } 73 | 74 | return 0; 75 | } 76 | 77 | -------------------------------------------------------------------------------- /tinyuntar/untar.c: -------------------------------------------------------------------------------- 1 | #include "untar.h" 2 | 3 | char *empty_string = ""; 4 | 5 | int parse_header(const unsigned char buffer[512], header_t *header) 6 | { 7 | memcpy(header, buffer, sizeof(header_t)); 8 | 9 | return 0; 10 | } 11 | 12 | static void log_error(const char *message) 13 | { 14 | printf("ERROR: %s\n", message); 15 | } 16 | 17 | static void log_debug(const char *message) 18 | { 19 | printf("DEBUG: %s\n", message); 20 | } 21 | 22 | unsigned long long decode_base256(const unsigned char *buffer) 23 | { 24 | return 0; 25 | } 26 | 27 | static void dump_hex(const char *ptr, int length) 28 | { 29 | int i = 0; 30 | printf("DUMP: "); 31 | 32 | while(i < length) 33 | { 34 | printf("%c", (ptr[i] >= 0x20 ? ptr[i] : '.')); 35 | 36 | i++; 37 | } 38 | 39 | printf("\n"); 40 | 41 | i = 0; 42 | while(i < length) 43 | { 44 | printf("%X ", ptr[i]); 45 | 46 | i++; 47 | } 48 | 49 | printf("\n\n"); 50 | } 51 | 52 | char *trim(char *raw, int length) 53 | { 54 | int i = 0; 55 | int j = length - 1; 56 | int is_empty = 0; 57 | 58 | // Determine left padding. 59 | while((raw[i] == 0 || raw[i] == ' ')) 60 | { 61 | i++; 62 | 63 | if(i >= length) 64 | { 65 | is_empty = 1; 66 | break; 67 | } 68 | } 69 | 70 | if(is_empty == 1) 71 | return empty_string; 72 | 73 | // Determine right padding. 74 | while((raw[j] == 0 || raw[j] == ' ')) 75 | { 76 | j--; 77 | 78 | if(j <= i) 79 | break; 80 | } 81 | 82 | // Place the terminator. 83 | raw[j + 1] = 0; 84 | 85 | // Return an offset pointer. 86 | return &raw[i]; 87 | } 88 | 89 | int translate_header(header_t *raw_header, header_translated_t *parsed) 90 | { 91 | char buffer[101]; 92 | char *buffer_ptr; 93 | const int R_OCTAL = 8; 94 | 95 | // 96 | 97 | memcpy(buffer, raw_header->filename, 100); 98 | buffer_ptr = trim(buffer, 100); 99 | strcpy(parsed->filename, buffer_ptr); 100 | parsed->filename[strlen(buffer_ptr)] = 0; 101 | 102 | // 103 | 104 | memcpy(buffer, raw_header->filemode, 8); 105 | buffer_ptr = trim(buffer, 8); 106 | 107 | if(IS_BASE256_ENCODED(buffer) != 0) 108 | parsed->filemode = decode_base256(buffer_ptr); 109 | else 110 | parsed->filemode = strtoull(buffer_ptr, NULL, R_OCTAL); 111 | 112 | // 113 | 114 | memcpy(buffer, raw_header->uid, 8); 115 | buffer_ptr = trim(buffer, 8); 116 | 117 | if(IS_BASE256_ENCODED(buffer) != 0) 118 | parsed->uid = decode_base256(buffer_ptr); 119 | else 120 | parsed->uid = strtoull(buffer_ptr, NULL, R_OCTAL); 121 | 122 | // 123 | 124 | memcpy(buffer, raw_header->gid, 8); 125 | buffer_ptr = trim(buffer, 8); 126 | 127 | if(IS_BASE256_ENCODED(buffer) != 0) 128 | parsed->gid = decode_base256(buffer_ptr); 129 | else 130 | parsed->gid = strtoull(buffer_ptr, NULL, R_OCTAL); 131 | 132 | // 133 | 134 | memcpy(buffer, raw_header->filesize, 12); 135 | buffer_ptr = trim(buffer, 12); 136 | 137 | if(IS_BASE256_ENCODED(buffer) != 0) 138 | parsed->filesize = decode_base256(buffer_ptr); 139 | else 140 | parsed->filesize = strtoull(buffer_ptr, NULL, R_OCTAL); 141 | 142 | // 143 | 144 | memcpy(buffer, raw_header->mtime, 12); 145 | buffer_ptr = trim(buffer, 12); 146 | 147 | if(IS_BASE256_ENCODED(buffer) != 0) 148 | parsed->mtime = decode_base256(buffer_ptr); 149 | else 150 | parsed->mtime = strtoull(buffer_ptr, NULL, R_OCTAL); 151 | 152 | // 153 | 154 | memcpy(buffer, raw_header->checksum, 8); 155 | buffer_ptr = trim(buffer, 8); 156 | 157 | if(IS_BASE256_ENCODED(buffer) != 0) 158 | parsed->checksum = decode_base256(buffer_ptr); 159 | else 160 | parsed->checksum = strtoull(buffer_ptr, NULL, R_OCTAL); 161 | 162 | // 163 | 164 | parsed->type = get_type_from_char(raw_header->type); 165 | 166 | memcpy(buffer, raw_header->link_target, 100); 167 | buffer_ptr = trim(buffer, 100); 168 | strcpy(parsed->link_target, buffer_ptr); 169 | parsed->link_target[strlen(buffer_ptr)] = 0; 170 | 171 | // 172 | 173 | memcpy(buffer, raw_header->ustar_indicator, 6); 174 | buffer_ptr = trim(buffer, 6); 175 | strcpy(parsed->ustar_indicator, buffer_ptr); 176 | parsed->ustar_indicator[strlen(buffer_ptr)] = 0; 177 | 178 | // 179 | 180 | memcpy(buffer, raw_header->ustar_version, 2); 181 | buffer_ptr = trim(buffer, 2); 182 | strcpy(parsed->ustar_version, buffer_ptr); 183 | parsed->ustar_version[strlen(buffer_ptr)] = 0; 184 | 185 | if(strcmp(parsed->ustar_indicator, "ustar") == 0) 186 | { 187 | // 188 | 189 | memcpy(buffer, raw_header->user_name, 32); 190 | buffer_ptr = trim(buffer, 32); 191 | strcpy(parsed->user_name, buffer_ptr); 192 | parsed->user_name[strlen(buffer_ptr)] = 0; 193 | 194 | // 195 | 196 | memcpy(buffer, raw_header->group_name, 32); 197 | buffer_ptr = trim(buffer, 32); 198 | strcpy(parsed->group_name, buffer_ptr); 199 | parsed->group_name[strlen(buffer_ptr)] = 0; 200 | 201 | // 202 | 203 | memcpy(buffer, raw_header->device_major, 8); 204 | buffer_ptr = trim(buffer, 8); 205 | 206 | if(IS_BASE256_ENCODED(buffer) != 0) 207 | parsed->device_major = decode_base256(buffer_ptr); 208 | else 209 | parsed->device_major = strtoull(buffer_ptr, NULL, R_OCTAL); 210 | 211 | // 212 | 213 | memcpy(buffer, raw_header->device_minor, 8); 214 | buffer_ptr = trim(buffer, 8); 215 | 216 | if(IS_BASE256_ENCODED(buffer) != 0) 217 | parsed->device_minor = decode_base256(buffer_ptr); 218 | else 219 | parsed->device_minor = strtoull(buffer_ptr, NULL, R_OCTAL); 220 | } 221 | else 222 | { 223 | strcpy(parsed->user_name, ""); 224 | strcpy(parsed->group_name, ""); 225 | 226 | parsed->device_major = 0; 227 | parsed->device_minor = 0; 228 | } 229 | 230 | return 0; 231 | } 232 | 233 | static int read_block(FILE *fp, unsigned char *buffer) 234 | { 235 | char message[200]; 236 | int num_read; 237 | 238 | num_read = fread(buffer, 1, TAR_BLOCK_SIZE, fp); 239 | if(num_read < TAR_BLOCK_SIZE) 240 | { 241 | snprintf(message, 200, "Read has stopped short at (%d) count " 242 | "rather than (%d). Quitting under error.", 243 | num_read, TAR_BLOCK_SIZE); 244 | 245 | log_error(message); 246 | return -1; 247 | } 248 | 249 | return 0; 250 | } 251 | 252 | int read_tar(const char *file_path, entry_callbacks_t *callbacks, void *context_data) 253 | { 254 | unsigned char buffer[TAR_BLOCK_SIZE + 1]; 255 | int header_checked = 0; 256 | int i; 257 | 258 | FILE *fp; 259 | 260 | header_t header; 261 | header_translated_t header_translated; 262 | 263 | int num_blocks; 264 | int current_data_size; 265 | int entry_index = 0; 266 | int empty_count = 0; 267 | 268 | buffer[TAR_BLOCK_SIZE] = 0; 269 | 270 | if((fp = fopen(file_path, "rb")) == NULL) 271 | { 272 | log_error("Could not open archive."); 273 | return -1; 274 | } 275 | 276 | // The end of the file is represented by two empty entries (which we 277 | // expediently identify by filename length). 278 | while(empty_count < 2) 279 | { 280 | if(read_block(fp, buffer) != 0) 281 | break; 282 | 283 | // If we haven't yet determined what format to support, read the 284 | // header of the next entry, now. This should be done only at the 285 | // top of the archive. 286 | 287 | if(parse_header(buffer, &header) != 0) 288 | { 289 | log_error("Could not understand the header of the first entry in the TAR."); 290 | return -3; 291 | } 292 | 293 | else if(strlen(header.filename) == 0) 294 | empty_count++; 295 | 296 | else 297 | { 298 | if(translate_header(&header, &header_translated) != 0) 299 | { 300 | log_error("Could not translate header."); 301 | return -4; 302 | } 303 | 304 | if(callbacks->header_cb(&header_translated, entry_index, context_data) != 0) 305 | { 306 | log_error("Header callback failed."); 307 | return -5; 308 | } 309 | 310 | i = 0; 311 | int received_bytes = 0; 312 | num_blocks = GET_NUM_BLOCKS(header_translated.filesize); 313 | while(i < num_blocks) 314 | { 315 | if(read_block(fp, buffer) != 0) 316 | { 317 | log_error("Could not read block. File too short."); 318 | return -6; 319 | } 320 | 321 | if(i >= num_blocks - 1) 322 | current_data_size = get_last_block_portion_size(header_translated.filesize); 323 | else 324 | current_data_size = TAR_BLOCK_SIZE; 325 | 326 | buffer[current_data_size] = 0; 327 | 328 | if(callbacks->data_cb(&header_translated, entry_index, context_data, buffer, current_data_size) != 0) 329 | { 330 | log_error("Data callback failed."); 331 | return -7; 332 | } 333 | 334 | i++; 335 | received_bytes += current_data_size; 336 | } 337 | 338 | if(callbacks->end_cb(&header_translated, entry_index, context_data) != 0) 339 | { 340 | log_error("End callback failed."); 341 | return -5; 342 | } 343 | } 344 | 345 | entry_index++; 346 | } 347 | 348 | fclose(fp); 349 | 350 | return 0; 351 | } 352 | 353 | void dump_header(header_translated_t *header) 354 | { 355 | printf("===========================================\n"); 356 | printf(" filename: %s\n", header->filename); 357 | printf(" filemode: 0%o (%llu)\n", (unsigned int)header->filemode, header->filemode); 358 | printf(" uid: 0%o (%llu)\n", (unsigned int)header->uid, header->uid); 359 | printf(" gid: 0%o (%llu)\n", (unsigned int)header->gid, header->gid); 360 | printf(" filesize: 0%o (%llu)\n", (unsigned int)header->filesize, header->filesize); 361 | printf(" mtime: 0%o (%llu)\n", (unsigned int)header->mtime, header->mtime); 362 | printf(" checksum: 0%o (%llu)\n", (unsigned int)header->checksum, header->checksum); 363 | printf(" type: %d\n", header->type); 364 | printf(" link_target: %s\n", header->link_target); 365 | printf("\n"); 366 | 367 | printf(" ustar ind: %s\n", header->ustar_indicator); 368 | printf(" ustar ver: %s\n", header->ustar_version); 369 | printf(" user name: %s\n", header->user_name); 370 | printf(" group name: %s\n", header->group_name); 371 | printf("device (major): %llu\n", header->device_major); 372 | printf("device (minor): %llu\n", header->device_minor); 373 | printf("\n"); 374 | 375 | printf(" data blocks = %d\n", GET_NUM_BLOCKS(header->filesize)); 376 | printf(" last block portion = %d\n", get_last_block_portion_size(header->filesize)); 377 | printf("===========================================\n"); 378 | printf("\n"); 379 | } 380 | 381 | enum entry_type_e get_type_from_char(char raw_type) 382 | { 383 | switch(raw_type) 384 | { 385 | case TAR_T_NORMAL1: 386 | case TAR_T_NORMAL2: 387 | return T_NORMAL; 388 | 389 | case TAR_T_HARD: 390 | return T_HARDLINK; 391 | 392 | case TAR_T_SYMBOLIC: 393 | return T_SYMBOLIC; 394 | 395 | case TAR_T_CHARSPECIAL: 396 | return T_CHARSPECIAL; 397 | 398 | case TAR_T_BLOCKSPECIAL: 399 | return T_CHARSPECIAL; 400 | 401 | case TAR_T_DIRECTORY: 402 | return T_DIRECTORY; 403 | 404 | case TAR_T_FIFO: 405 | return T_FIFO; 406 | 407 | case TAR_T_CONTIGUOUS: 408 | return T_CONTIGUOUS; 409 | 410 | case TAR_T_GLOBALEXTENDED: 411 | return T_GLOBALEXTENDED; 412 | 413 | case TAR_T_EXTENDED: 414 | return T_EXTENDED; 415 | } 416 | 417 | return T_OTHER; 418 | } 419 | 420 | int inline get_last_block_portion_size(int filesize) 421 | { 422 | const int partial = filesize % TAR_BLOCK_SIZE; 423 | return (partial > 0 ? partial : TAR_BLOCK_SIZE); 424 | } 425 | -------------------------------------------------------------------------------- /tinyuntar/untar.h: -------------------------------------------------------------------------------- 1 | #ifndef __UNTAR_H 2 | #define __UNTAR_H 3 | 4 | #include 5 | #include 6 | #include 7 | #include 8 | 9 | #define IS_BASE256_ENCODED(buffer) (((unsigned char)buffer[0] & 0x80) > 0) 10 | #define GET_NUM_BLOCKS(filesize) (int)ceil((double)filesize / (double)TAR_BLOCK_SIZE) 11 | 12 | int inline get_last_block_portion_size(int filesize); 13 | 14 | #ifdef _MSC_VER 15 | #define strtoull _strtoui64 16 | #define snprintf _snprintf 17 | #endif 18 | 19 | #define TAR_T_NORMAL1 0 20 | #define TAR_T_NORMAL2 '0' 21 | #define TAR_T_HARD '1' 22 | #define TAR_T_SYMBOLIC '2' 23 | #define TAR_T_CHARSPECIAL '3' 24 | #define TAR_T_BLOCKSPECIAL '4' 25 | #define TAR_T_DIRECTORY '5' 26 | #define TAR_T_FIFO '6' 27 | #define TAR_T_CONTIGUOUS '7' 28 | #define TAR_T_GLOBALEXTENDED 'g' 29 | #define TAR_T_EXTENDED 'x' 30 | 31 | #define TAR_BLOCK_SIZE 512 32 | 33 | #define TAR_HT_PRE11988 1 34 | #define TAR_HT_P10031 2 35 | 36 | enum entry_type_e { T_NORMAL, T_HARDLINK, T_SYMBOLIC, T_CHARSPECIAL, 37 | T_BLOCKSPECIAL, T_DIRECTORY, T_FIFO, T_CONTIGUOUS, 38 | T_GLOBALEXTENDED, T_EXTENDED, T_OTHER }; 39 | 40 | // Describes a header for TARs conforming to pre-POSIX.1-1988 . 41 | struct header_s 42 | { 43 | char filename[100]; 44 | char filemode[8]; 45 | char uid[8]; 46 | char gid[8]; 47 | char filesize[12]; 48 | char mtime[12]; 49 | char checksum[8]; 50 | char type; 51 | char link_target[100]; 52 | 53 | char ustar_indicator[6]; 54 | char ustar_version[2]; 55 | char user_name[32]; 56 | char group_name[32]; 57 | char device_major[8]; 58 | char device_minor[8]; 59 | }; 60 | 61 | typedef struct header_s header_t; 62 | 63 | struct header_translated_s 64 | { 65 | char filename[101]; 66 | unsigned long long filemode; 67 | unsigned long long uid; 68 | unsigned long long gid; 69 | unsigned long long filesize; 70 | unsigned long long mtime; 71 | unsigned long long checksum; 72 | enum entry_type_e type; 73 | char link_target[101]; 74 | 75 | char ustar_indicator[6]; 76 | char ustar_version[3]; 77 | char user_name[32]; 78 | char group_name[32]; 79 | unsigned long long device_major; 80 | unsigned long long device_minor; 81 | }; 82 | 83 | typedef struct header_translated_s header_translated_t; 84 | 85 | typedef int (*entry_header_callback_t)(header_translated_t *header, 86 | int entry_index, 87 | void *context_data); 88 | 89 | typedef int (*entry_data_callback_t)(header_translated_t *header, 90 | int entry_index, 91 | void *context_data, 92 | unsigned char *block, 93 | int length); 94 | 95 | typedef int (*entry_end_callback_t)(header_translated_t *header, 96 | int entry_index, 97 | void *context_data); 98 | 99 | struct entry_callbacks_s 100 | { 101 | entry_header_callback_t header_cb; 102 | entry_data_callback_t data_cb; 103 | entry_end_callback_t end_cb; 104 | }; 105 | 106 | typedef struct entry_callbacks_s entry_callbacks_t; 107 | 108 | int read_tar(const char *file_path, entry_callbacks_t *callbacks, void *context_data); 109 | void dump_header(header_translated_t *header); 110 | unsigned long long decode_base256(unsigned const char *buffer); 111 | char *trim(char *raw, int length); 112 | int parse_header(unsigned const char buffer[512], header_t *header); 113 | int translate_header(header_t *raw_header, header_translated_t *parsed); 114 | enum entry_type_e get_type_from_char(char raw_type); 115 | 116 | #endif 117 | 118 | --------------------------------------------------------------------------------