2 * Copyright (c) 2003-2007 Tim Kientzle
3 * Copyright (c) 2011-2012 Michihiro NAKAJIMA
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include "archive_platform.h"
28 __FBSDID("$FreeBSD$");
42 #include "archive_acl_private.h" /* For ACL parsing routines. */
43 #include "archive_entry.h"
44 #include "archive_entry_locale.h"
45 #include "archive_private.h"
46 #include "archive_read_private.h"
48 #define tar_min(a,b) ((a) < (b) ? (a) : (b))
51 * Layout of POSIX 'ustar' tar header.
53 struct archive_entry_header_ustar {
62 char linkname[100]; /* "old format" header ends here */
63 char magic[6]; /* For POSIX: "ustar\0" */
64 char version[2]; /* For POSIX: "00" */
73 * Structure of GNU tar header
80 struct archive_entry_header_gnutar {
90 char magic[8]; /* "ustar \0" (note blank/blank/null at end) */
100 struct gnu_sparse sparse[4];
104 * Old GNU format doesn't use POSIX 'prefix' field; they use
105 * the 'L' (longname) entry instead.
110 * Data specific to this format.
112 struct sparse_block {
113 struct sparse_block *next;
120 struct archive_string acl_text;
121 struct archive_string entry_pathname;
122 /* For "GNU.sparse.name" and other similar path extensions. */
123 struct archive_string entry_pathname_override;
124 struct archive_string entry_linkpath;
125 struct archive_string entry_uname;
126 struct archive_string entry_gname;
127 struct archive_string longlink;
128 struct archive_string longname;
129 struct archive_string pax_header;
130 struct archive_string pax_global;
131 struct archive_string line;
132 int pax_hdrcharset_binary;
133 int header_recursion_depth;
134 int64_t entry_bytes_remaining;
135 int64_t entry_offset;
136 int64_t entry_padding;
137 int64_t entry_bytes_unconsumed;
139 struct sparse_block *sparse_list;
140 struct sparse_block *sparse_last;
141 int64_t sparse_offset;
142 int64_t sparse_numbytes;
143 int sparse_gnu_major;
144 int sparse_gnu_minor;
145 char sparse_gnu_pending;
147 struct archive_string localname;
148 struct archive_string_conv *opt_sconv;
149 struct archive_string_conv *sconv;
150 struct archive_string_conv *sconv_acl;
151 struct archive_string_conv *sconv_default;
152 int init_default_conversion;
154 int process_mac_extensions;
155 int read_concatenated_archives;
158 static int archive_block_is_null(const char *p);
159 static char *base64_decode(const char *, size_t, size_t *);
160 static int gnu_add_sparse_entry(struct archive_read *, struct tar *,
161 int64_t offset, int64_t remaining);
163 static void gnu_clear_sparse_list(struct tar *);
164 static int gnu_sparse_old_read(struct archive_read *, struct tar *,
165 const struct archive_entry_header_gnutar *header, size_t *);
166 static int gnu_sparse_old_parse(struct archive_read *, struct tar *,
167 const struct gnu_sparse *sparse, int length);
168 static int gnu_sparse_01_parse(struct archive_read *, struct tar *,
170 static ssize_t gnu_sparse_10_read(struct archive_read *, struct tar *,
172 static int header_Solaris_ACL(struct archive_read *, struct tar *,
173 struct archive_entry *, const void *, size_t *);
174 static int header_common(struct archive_read *, struct tar *,
175 struct archive_entry *, const void *);
176 static int header_old_tar(struct archive_read *, struct tar *,
177 struct archive_entry *, const void *);
178 static int header_pax_extensions(struct archive_read *, struct tar *,
179 struct archive_entry *, const void *, size_t *);
180 static int header_pax_global(struct archive_read *, struct tar *,
181 struct archive_entry *, const void *h, size_t *);
182 static int header_longlink(struct archive_read *, struct tar *,
183 struct archive_entry *, const void *h, size_t *);
184 static int header_longname(struct archive_read *, struct tar *,
185 struct archive_entry *, const void *h, size_t *);
186 static int read_mac_metadata_blob(struct archive_read *, struct tar *,
187 struct archive_entry *, const void *h, size_t *);
188 static int header_volume(struct archive_read *, struct tar *,
189 struct archive_entry *, const void *h, size_t *);
190 static int header_ustar(struct archive_read *, struct tar *,
191 struct archive_entry *, const void *h);
192 static int header_gnutar(struct archive_read *, struct tar *,
193 struct archive_entry *, const void *h, size_t *);
194 static int archive_read_format_tar_bid(struct archive_read *, int);
195 static int archive_read_format_tar_options(struct archive_read *,
196 const char *, const char *);
197 static int archive_read_format_tar_cleanup(struct archive_read *);
198 static int archive_read_format_tar_read_data(struct archive_read *a,
199 const void **buff, size_t *size, int64_t *offset);
200 static int archive_read_format_tar_skip(struct archive_read *a);
201 static int archive_read_format_tar_read_header(struct archive_read *,
202 struct archive_entry *);
203 static int checksum(struct archive_read *, const void *);
204 static int pax_attribute(struct archive_read *, struct tar *,
205 struct archive_entry *, const char *key, const char *value);
206 static int pax_header(struct archive_read *, struct tar *,
207 struct archive_entry *, char *attr);
208 static void pax_time(const char *, int64_t *sec, long *nanos);
209 static ssize_t readline(struct archive_read *, struct tar *, const char **,
210 ssize_t limit, size_t *);
211 static int read_body_to_string(struct archive_read *, struct tar *,
212 struct archive_string *, const void *h, size_t *);
213 static int solaris_sparse_parse(struct archive_read *, struct tar *,
214 struct archive_entry *, const char *);
215 static int64_t tar_atol(const char *, size_t);
216 static int64_t tar_atol10(const char *, size_t);
217 static int64_t tar_atol256(const char *, size_t);
218 static int64_t tar_atol8(const char *, size_t);
219 static int tar_read_header(struct archive_read *, struct tar *,
220 struct archive_entry *, size_t *);
221 static int tohex(int c);
222 static char *url_decode(const char *);
223 static void tar_flush_unconsumed(struct archive_read *, size_t *);
227 archive_read_support_format_gnutar(struct archive *a)
229 archive_check_magic(a, ARCHIVE_READ_MAGIC,
230 ARCHIVE_STATE_NEW, "archive_read_support_format_gnutar");
231 return (archive_read_support_format_tar(a));
236 archive_read_support_format_tar(struct archive *_a)
238 struct archive_read *a = (struct archive_read *)_a;
242 archive_check_magic(_a, ARCHIVE_READ_MAGIC,
243 ARCHIVE_STATE_NEW, "archive_read_support_format_tar");
245 tar = (struct tar *)calloc(1, sizeof(*tar));
246 #ifdef HAVE_COPYFILE_H
247 /* Set this by default on Mac OS. */
248 tar->process_mac_extensions = 1;
251 archive_set_error(&a->archive, ENOMEM,
252 "Can't allocate tar data");
253 return (ARCHIVE_FATAL);
256 r = __archive_read_register_format(a, tar, "tar",
257 archive_read_format_tar_bid,
258 archive_read_format_tar_options,
259 archive_read_format_tar_read_header,
260 archive_read_format_tar_read_data,
261 archive_read_format_tar_skip,
263 archive_read_format_tar_cleanup,
273 archive_read_format_tar_cleanup(struct archive_read *a)
277 tar = (struct tar *)(a->format->data);
278 gnu_clear_sparse_list(tar);
279 archive_string_free(&tar->acl_text);
280 archive_string_free(&tar->entry_pathname);
281 archive_string_free(&tar->entry_pathname_override);
282 archive_string_free(&tar->entry_linkpath);
283 archive_string_free(&tar->entry_uname);
284 archive_string_free(&tar->entry_gname);
285 archive_string_free(&tar->line);
286 archive_string_free(&tar->pax_global);
287 archive_string_free(&tar->pax_header);
288 archive_string_free(&tar->longname);
289 archive_string_free(&tar->longlink);
290 archive_string_free(&tar->localname);
292 (a->format->data) = NULL;
298 archive_read_format_tar_bid(struct archive_read *a, int best_bid)
302 const struct archive_entry_header_ustar *header;
304 (void)best_bid; /* UNUSED */
308 /* Now let's look at the actual header and see if it matches. */
309 h = __archive_read_ahead(a, 512, NULL);
313 /* If it's an end-of-archive mark, we can handle it. */
314 if (h[0] == 0 && archive_block_is_null(h)) {
316 * Usually, I bid the number of bits verified, but
317 * in this case, 4096 seems excessive so I picked 10 as
318 * an arbitrary but reasonable-seeming value.
323 /* If it's not an end-of-archive mark, it must have a valid checksum.*/
326 bid += 48; /* Checksum is usually 6 octal digits. */
328 header = (const struct archive_entry_header_ustar *)h;
330 /* Recognize POSIX formats. */
331 if ((memcmp(header->magic, "ustar\0", 6) == 0)
332 && (memcmp(header->version, "00", 2) == 0))
335 /* Recognize GNU tar format. */
336 if ((memcmp(header->magic, "ustar ", 6) == 0)
337 && (memcmp(header->version, " \0", 2) == 0))
340 /* Type flag must be null, digit or A-Z, a-z. */
341 if (header->typeflag[0] != 0 &&
342 !( header->typeflag[0] >= '0' && header->typeflag[0] <= '9') &&
343 !( header->typeflag[0] >= 'A' && header->typeflag[0] <= 'Z') &&
344 !( header->typeflag[0] >= 'a' && header->typeflag[0] <= 'z') )
346 bid += 2; /* 6 bits of variation in an 8-bit field leaves 2 bits. */
348 /* Sanity check: Look at first byte of mode field. */
349 switch (255 & (unsigned)header->mode[0]) {
351 /* Base-256 value: No further verification possible! */
353 case ' ': /* Not recommended, but not illegal, either. */
355 case '0': case '1': case '2': case '3':
356 case '4': case '5': case '6': case '7':
358 /* TODO: Check format of remainder of this field. */
361 /* Not a valid mode; bail out here. */
364 /* TODO: Sanity test uid/gid/size/mtime/rdevmajor/rdevminor fields. */
370 archive_read_format_tar_options(struct archive_read *a,
371 const char *key, const char *val)
374 int ret = ARCHIVE_FAILED;
376 tar = (struct tar *)(a->format->data);
377 if (strcmp(key, "compat-2x") == 0) {
378 /* Handle UTF-8 filnames as libarchive 2.x */
379 tar->compat_2x = (val != NULL && val[0] != 0);
380 tar->init_default_conversion = tar->compat_2x;
382 } else if (strcmp(key, "hdrcharset") == 0) {
383 if (val == NULL || val[0] == 0)
384 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
385 "tar: hdrcharset option needs a character-set name");
388 archive_string_conversion_from_charset(
389 &a->archive, val, 0);
390 if (tar->opt_sconv != NULL)
396 } else if (strcmp(key, "mac-ext") == 0) {
397 tar->process_mac_extensions = (val != NULL && val[0] != 0);
399 } else if (strcmp(key, "read_concatenated_archives") == 0) {
400 tar->read_concatenated_archives = (val != NULL && val[0] != 0);
404 /* Note: The "warn" return is just to inform the options
405 * supervisor that we didn't handle it. It will generate
406 * a suitable error if no one used this option. */
407 return (ARCHIVE_WARN);
410 /* utility function- this exists to centralize the logic of tracking
411 * how much unconsumed data we have floating around, and to consume
412 * anything outstanding since we're going to do read_aheads
415 tar_flush_unconsumed(struct archive_read *a, size_t *unconsumed)
419 void *data = (void *)__archive_read_ahead(a, *unconsumed, NULL);
420 * this block of code is to poison claimed unconsumed space, ensuring
421 * things break if it is in use still.
422 * currently it WILL break things, so enable it only for debugging this issue
424 memset(data, 0xff, *unconsumed);
427 __archive_read_consume(a, *unconsumed);
433 * The function invoked by archive_read_next_header(). This
434 * just sets up a few things and then calls the internal
435 * tar_read_header() function below.
438 archive_read_format_tar_read_header(struct archive_read *a,
439 struct archive_entry *entry)
442 * When converting tar archives to cpio archives, it is
443 * essential that each distinct file have a distinct inode
444 * number. To simplify this, we keep a static count here to
445 * assign fake dev/inode numbers to each tar entry. Note that
446 * pax format archives may overwrite this with something more
449 * Ideally, we would track every file read from the archive so
450 * that we could assign the same dev/ino pair to hardlinks,
451 * but the memory required to store a complete lookup table is
452 * probably not worthwhile just to support the relatively
453 * obscure tar->cpio conversion case.
455 static int default_inode;
456 static int default_dev;
461 size_t l, unconsumed = 0;
463 /* Assign default device/inode values. */
464 archive_entry_set_dev(entry, 1 + default_dev); /* Don't use zero. */
465 archive_entry_set_ino(entry, ++default_inode); /* Don't use zero. */
466 /* Limit generated st_ino number to 16 bits. */
467 if (default_inode >= 0xffff) {
472 tar = (struct tar *)(a->format->data);
473 tar->entry_offset = 0;
474 gnu_clear_sparse_list(tar);
475 tar->realsize = -1; /* Mark this as "unset" */
477 /* Setup default string conversion. */
478 tar->sconv = tar->opt_sconv;
479 if (tar->sconv == NULL) {
480 if (!tar->init_default_conversion) {
482 archive_string_default_conversion_for_read(&(a->archive));
483 tar->init_default_conversion = 1;
485 tar->sconv = tar->sconv_default;
488 r = tar_read_header(a, tar, entry, &unconsumed);
490 tar_flush_unconsumed(a, &unconsumed);
493 * "non-sparse" files are really just sparse files with
496 if (tar->sparse_list == NULL) {
497 if (gnu_add_sparse_entry(a, tar, 0, tar->entry_bytes_remaining)
499 return (ARCHIVE_FATAL);
501 struct sparse_block *sb;
503 for (sb = tar->sparse_list; sb != NULL; sb = sb->next) {
505 archive_entry_sparse_add_entry(entry,
506 sb->offset, sb->remaining);
510 if (r == ARCHIVE_OK && archive_entry_filetype(entry) == AE_IFREG) {
512 * "Regular" entry with trailing '/' is really
513 * directory: This is needed for certain old tar
514 * variants and even for some broken newer ones.
516 if ((wp = archive_entry_pathname_w(entry)) != NULL) {
518 if (l > 0 && wp[l - 1] == L'/') {
519 archive_entry_set_filetype(entry, AE_IFDIR);
521 } else if ((p = archive_entry_pathname(entry)) != NULL) {
523 if (l > 0 && p[l - 1] == '/') {
524 archive_entry_set_filetype(entry, AE_IFDIR);
532 archive_read_format_tar_read_data(struct archive_read *a,
533 const void **buff, size_t *size, int64_t *offset)
537 struct sparse_block *p;
539 tar = (struct tar *)(a->format->data);
542 /* Remove exhausted entries from sparse list. */
543 while (tar->sparse_list != NULL &&
544 tar->sparse_list->remaining == 0) {
545 p = tar->sparse_list;
546 tar->sparse_list = p->next;
550 if (tar->entry_bytes_unconsumed) {
551 __archive_read_consume(a, tar->entry_bytes_unconsumed);
552 tar->entry_bytes_unconsumed = 0;
555 /* If we're at end of file, return EOF. */
556 if (tar->sparse_list == NULL ||
557 tar->entry_bytes_remaining == 0) {
558 if (__archive_read_consume(a, tar->entry_padding) < 0)
559 return (ARCHIVE_FATAL);
560 tar->entry_padding = 0;
563 *offset = tar->realsize;
564 return (ARCHIVE_EOF);
567 *buff = __archive_read_ahead(a, 1, &bytes_read);
569 return (ARCHIVE_FATAL);
571 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
572 "Truncated tar archive");
573 return (ARCHIVE_FATAL);
575 if (bytes_read > tar->entry_bytes_remaining)
576 bytes_read = (ssize_t)tar->entry_bytes_remaining;
577 /* Don't read more than is available in the
578 * current sparse block. */
579 if (tar->sparse_list->remaining < bytes_read)
580 bytes_read = (ssize_t)tar->sparse_list->remaining;
582 *offset = tar->sparse_list->offset;
583 tar->sparse_list->remaining -= bytes_read;
584 tar->sparse_list->offset += bytes_read;
585 tar->entry_bytes_remaining -= bytes_read;
586 tar->entry_bytes_unconsumed = bytes_read;
588 if (!tar->sparse_list->hole)
590 /* Current is hole data and skip this. */
595 archive_read_format_tar_skip(struct archive_read *a)
597 int64_t bytes_skipped;
599 struct sparse_block *p;
602 tar = (struct tar *)(a->format->data);
604 /* Do not consume the hole of a sparse file. */
606 for (p = tar->sparse_list; p != NULL; p = p->next) {
608 if (p->remaining >= INT64_MAX - request) {
609 return ARCHIVE_FATAL;
611 request += p->remaining;
614 if (request > tar->entry_bytes_remaining)
615 request = tar->entry_bytes_remaining;
616 request += tar->entry_padding + tar->entry_bytes_unconsumed;
618 bytes_skipped = __archive_read_consume(a, request);
619 if (bytes_skipped < 0)
620 return (ARCHIVE_FATAL);
622 tar->entry_bytes_remaining = 0;
623 tar->entry_bytes_unconsumed = 0;
624 tar->entry_padding = 0;
626 /* Free the sparse list. */
627 gnu_clear_sparse_list(tar);
633 * This function recursively interprets all of the headers associated
634 * with a single entry.
637 tar_read_header(struct archive_read *a, struct tar *tar,
638 struct archive_entry *entry, size_t *unconsumed)
643 const struct archive_entry_header_ustar *header;
644 const struct archive_entry_header_gnutar *gnuheader;
646 /* Loop until we find a workable header record. */
648 tar_flush_unconsumed(a, unconsumed);
650 /* Read 512-byte header record */
651 h = __archive_read_ahead(a, 512, &bytes);
654 if (bytes == 0) { /* EOF at a block boundary. */
655 /* Some writers do omit the block of nulls. <sigh> */
656 return (ARCHIVE_EOF);
658 if (bytes < 512) { /* Short block at EOF; this is bad. */
659 archive_set_error(&a->archive,
660 ARCHIVE_ERRNO_FILE_FORMAT,
661 "Truncated tar archive");
662 return (ARCHIVE_FATAL);
666 /* Header is workable if it's not an end-of-archive mark. */
667 if (h[0] != 0 || !archive_block_is_null(h))
670 /* Ensure format is set for archives with only null blocks. */
671 if (a->archive.archive_format_name == NULL) {
672 a->archive.archive_format = ARCHIVE_FORMAT_TAR;
673 a->archive.archive_format_name = "tar";
676 if (!tar->read_concatenated_archives) {
677 /* Try to consume a second all-null record, as well. */
678 tar_flush_unconsumed(a, unconsumed);
679 h = __archive_read_ahead(a, 512, NULL);
680 if (h != NULL && h[0] == 0 && archive_block_is_null(h))
681 __archive_read_consume(a, 512);
682 archive_clear_error(&a->archive);
683 return (ARCHIVE_EOF);
687 * We're reading concatenated archives, ignore this block and
688 * loop to get the next.
693 * Note: If the checksum fails and we return ARCHIVE_RETRY,
694 * then the client is likely to just retry. This is a very
695 * crude way to search for the next valid header!
697 * TODO: Improve this by implementing a real header scan.
699 if (!checksum(a, h)) {
700 tar_flush_unconsumed(a, unconsumed);
701 archive_set_error(&a->archive, EINVAL, "Damaged tar archive");
702 return (ARCHIVE_RETRY); /* Retryable: Invalid header */
705 if (++tar->header_recursion_depth > 32) {
706 tar_flush_unconsumed(a, unconsumed);
707 archive_set_error(&a->archive, EINVAL, "Too many special headers");
708 return (ARCHIVE_WARN);
711 /* Determine the format variant. */
712 header = (const struct archive_entry_header_ustar *)h;
714 switch(header->typeflag[0]) {
715 case 'A': /* Solaris tar ACL */
716 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
717 a->archive.archive_format_name = "Solaris tar";
718 err = header_Solaris_ACL(a, tar, entry, h, unconsumed);
720 case 'g': /* POSIX-standard 'g' header. */
721 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
722 a->archive.archive_format_name = "POSIX pax interchange format";
723 err = header_pax_global(a, tar, entry, h, unconsumed);
724 if (err == ARCHIVE_EOF)
727 case 'K': /* Long link name (GNU tar, others) */
728 err = header_longlink(a, tar, entry, h, unconsumed);
730 case 'L': /* Long filename (GNU tar, others) */
731 err = header_longname(a, tar, entry, h, unconsumed);
733 case 'V': /* GNU volume header */
734 err = header_volume(a, tar, entry, h, unconsumed);
736 case 'X': /* Used by SUN tar; same as 'x'. */
737 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
738 a->archive.archive_format_name =
739 "POSIX pax interchange format (Sun variant)";
740 err = header_pax_extensions(a, tar, entry, h, unconsumed);
742 case 'x': /* POSIX-standard 'x' header. */
743 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
744 a->archive.archive_format_name = "POSIX pax interchange format";
745 err = header_pax_extensions(a, tar, entry, h, unconsumed);
748 gnuheader = (const struct archive_entry_header_gnutar *)h;
749 if (memcmp(gnuheader->magic, "ustar \0", 8) == 0) {
750 a->archive.archive_format = ARCHIVE_FORMAT_TAR_GNUTAR;
751 a->archive.archive_format_name = "GNU tar format";
752 err = header_gnutar(a, tar, entry, h, unconsumed);
753 } else if (memcmp(header->magic, "ustar", 5) == 0) {
754 if (a->archive.archive_format != ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE) {
755 a->archive.archive_format = ARCHIVE_FORMAT_TAR_USTAR;
756 a->archive.archive_format_name = "POSIX ustar format";
758 err = header_ustar(a, tar, entry, h);
760 a->archive.archive_format = ARCHIVE_FORMAT_TAR;
761 a->archive.archive_format_name = "tar (non-POSIX)";
762 err = header_old_tar(a, tar, entry, h);
765 if (err == ARCHIVE_FATAL)
768 tar_flush_unconsumed(a, unconsumed);
773 --tar->header_recursion_depth;
774 /* Yuck. Apple's design here ends up storing long pathname
775 * extensions for both the AppleDouble extension entry and the
778 if ((err == ARCHIVE_WARN || err == ARCHIVE_OK) &&
779 tar->header_recursion_depth == 0 &&
780 tar->process_mac_extensions) {
781 int err2 = read_mac_metadata_blob(a, tar, entry, h, unconsumed);
786 /* We return warnings or success as-is. Anything else is fatal. */
787 if (err == ARCHIVE_WARN || err == ARCHIVE_OK) {
788 if (tar->sparse_gnu_pending) {
789 if (tar->sparse_gnu_major == 1 &&
790 tar->sparse_gnu_minor == 0) {
793 tar->sparse_gnu_pending = 0;
794 /* Read initial sparse map. */
795 bytes_read = gnu_sparse_10_read(a, tar, unconsumed);
796 tar->entry_bytes_remaining -= bytes_read;
798 return ((int)bytes_read);
800 archive_set_error(&a->archive,
802 "Unrecognized GNU sparse file format");
803 return (ARCHIVE_WARN);
805 tar->sparse_gnu_pending = 0;
809 if (err == ARCHIVE_EOF)
810 /* EOF when recursively reading a header is bad. */
811 archive_set_error(&a->archive, EINVAL, "Damaged tar archive");
812 return (ARCHIVE_FATAL);
816 * Return true if block checksum is correct.
819 checksum(struct archive_read *a, const void *h)
821 const unsigned char *bytes;
822 const struct archive_entry_header_ustar *header;
826 (void)a; /* UNUSED */
827 bytes = (const unsigned char *)h;
828 header = (const struct archive_entry_header_ustar *)h;
830 /* Checksum field must hold an octal number */
831 for (i = 0; i < sizeof(header->checksum); ++i) {
832 char c = header->checksum[i];
833 if (c != ' ' && c != '\0' && (c < '0' || c > '7'))
838 * Test the checksum. Note that POSIX specifies _unsigned_
839 * bytes for this calculation.
841 sum = (int)tar_atol(header->checksum, sizeof(header->checksum));
843 for (i = 0; i < 148; i++)
844 check += (unsigned char)bytes[i];
848 check += (unsigned char)bytes[i];
853 * Repeat test with _signed_ bytes, just in case this archive
854 * was created by an old BSD, Solaris, or HP-UX tar with a
855 * broken checksum calculation.
858 for (i = 0; i < 148; i++)
859 check += (signed char)bytes[i];
863 check += (signed char)bytes[i];
871 * Return true if this block contains only nulls.
874 archive_block_is_null(const char *p)
878 for (i = 0; i < 512; i++)
885 * Interpret 'A' Solaris ACL header
888 header_Solaris_ACL(struct archive_read *a, struct tar *tar,
889 struct archive_entry *entry, const void *h, size_t *unconsumed)
891 const struct archive_entry_header_ustar *header;
898 * read_body_to_string adds a NUL terminator, but we need a little
899 * more to make sure that we don't overrun acl_text later.
901 header = (const struct archive_entry_header_ustar *)h;
902 size = (size_t)tar_atol(header->size, sizeof(header->size));
903 err = read_body_to_string(a, tar, &(tar->acl_text), h, unconsumed);
904 if (err != ARCHIVE_OK)
907 /* Recursively read next header */
908 err = tar_read_header(a, tar, entry, unconsumed);
909 if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
912 /* TODO: Examine the first characters to see if this
913 * is an AIX ACL descriptor. We'll likely never support
914 * them, but it would be polite to recognize and warn when
917 /* Leading octal number indicates ACL type and number of entries. */
918 p = acl = tar->acl_text.s;
920 while (*p != '\0' && p < acl + size) {
921 if (*p < '0' || *p > '7') {
922 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
923 "Malformed Solaris ACL attribute (invalid digit)");
924 return(ARCHIVE_WARN);
928 if (type > 077777777) {
929 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
930 "Malformed Solaris ACL attribute (count too large)");
931 return (ARCHIVE_WARN);
935 switch ((int)type & ~0777777) {
940 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
941 "Solaris NFSv4 ACLs not supported");
942 return (ARCHIVE_WARN);
944 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
945 "Malformed Solaris ACL attribute (unsupported type %o)",
947 return (ARCHIVE_WARN);
951 if (p >= acl + size) {
952 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
953 "Malformed Solaris ACL attribute (body overflow)");
954 return(ARCHIVE_WARN);
957 /* ACL text is null-terminated; find the end. */
961 while (*p != '\0' && p < acl + size)
964 if (tar->sconv_acl == NULL) {
965 tar->sconv_acl = archive_string_conversion_from_charset(
966 &(a->archive), "UTF-8", 1);
967 if (tar->sconv_acl == NULL)
968 return (ARCHIVE_FATAL);
970 archive_strncpy(&(tar->localname), acl, p - acl);
971 err = archive_acl_parse_l(archive_entry_acl(entry),
972 tar->localname.s, ARCHIVE_ENTRY_ACL_TYPE_ACCESS, tar->sconv_acl);
973 if (err != ARCHIVE_OK) {
974 if (errno == ENOMEM) {
975 archive_set_error(&a->archive, ENOMEM,
976 "Can't allocate memory for ACL");
978 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
979 "Malformed Solaris ACL attribute (unparsable)");
985 * Interpret 'K' long linkname header.
988 header_longlink(struct archive_read *a, struct tar *tar,
989 struct archive_entry *entry, const void *h, size_t *unconsumed)
993 err = read_body_to_string(a, tar, &(tar->longlink), h, unconsumed);
994 if (err != ARCHIVE_OK)
996 err = tar_read_header(a, tar, entry, unconsumed);
997 if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
999 /* Set symlink if symlink already set, else hardlink. */
1000 archive_entry_copy_link(entry, tar->longlink.s);
1001 return (ARCHIVE_OK);
1005 set_conversion_failed_error(struct archive_read *a,
1006 struct archive_string_conv *sconv, const char *name)
1008 if (errno == ENOMEM) {
1009 archive_set_error(&a->archive, ENOMEM,
1010 "Can't allocate memory for %s", name);
1011 return (ARCHIVE_FATAL);
1013 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1014 "%s can't be converted from %s to current locale.",
1015 name, archive_string_conversion_charset_name(sconv));
1016 return (ARCHIVE_WARN);
1020 * Interpret 'L' long filename header.
1023 header_longname(struct archive_read *a, struct tar *tar,
1024 struct archive_entry *entry, const void *h, size_t *unconsumed)
1028 err = read_body_to_string(a, tar, &(tar->longname), h, unconsumed);
1029 if (err != ARCHIVE_OK)
1031 /* Read and parse "real" header, then override name. */
1032 err = tar_read_header(a, tar, entry, unconsumed);
1033 if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
1035 if (archive_entry_copy_pathname_l(entry, tar->longname.s,
1036 archive_strlen(&(tar->longname)), tar->sconv) != 0)
1037 err = set_conversion_failed_error(a, tar->sconv, "Pathname");
1043 * Interpret 'V' GNU tar volume header.
1046 header_volume(struct archive_read *a, struct tar *tar,
1047 struct archive_entry *entry, const void *h, size_t *unconsumed)
1051 /* Just skip this and read the next header. */
1052 return (tar_read_header(a, tar, entry, unconsumed));
1056 * Read body of an archive entry into an archive_string object.
1059 read_body_to_string(struct archive_read *a, struct tar *tar,
1060 struct archive_string *as, const void *h, size_t *unconsumed)
1063 const struct archive_entry_header_ustar *header;
1066 (void)tar; /* UNUSED */
1067 header = (const struct archive_entry_header_ustar *)h;
1068 size = tar_atol(header->size, sizeof(header->size));
1069 if ((size > 1048576) || (size < 0)) {
1070 archive_set_error(&a->archive, EINVAL,
1071 "Special header too large");
1072 return (ARCHIVE_FATAL);
1075 /* Fail if we can't make our buffer big enough. */
1076 if (archive_string_ensure(as, (size_t)size+1) == NULL) {
1077 archive_set_error(&a->archive, ENOMEM,
1079 return (ARCHIVE_FATAL);
1082 tar_flush_unconsumed(a, unconsumed);
1084 /* Read the body into the string. */
1085 *unconsumed = (size_t)((size + 511) & ~ 511);
1086 src = __archive_read_ahead(a, *unconsumed, NULL);
1089 return (ARCHIVE_FATAL);
1091 memcpy(as->s, src, (size_t)size);
1093 as->length = (size_t)size;
1094 return (ARCHIVE_OK);
1098 * Parse out common header elements.
1100 * This would be the same as header_old_tar, except that the
1101 * filename is handled slightly differently for old and POSIX
1102 * entries (POSIX entries support a 'prefix'). This factoring
1103 * allows header_old_tar and header_ustar
1104 * to handle filenames differently, while still putting most of the
1105 * common parsing into one place.
1108 header_common(struct archive_read *a, struct tar *tar,
1109 struct archive_entry *entry, const void *h)
1111 const struct archive_entry_header_ustar *header;
1113 int err = ARCHIVE_OK;
1115 header = (const struct archive_entry_header_ustar *)h;
1116 if (header->linkname[0])
1117 archive_strncpy(&(tar->entry_linkpath),
1118 header->linkname, sizeof(header->linkname));
1120 archive_string_empty(&(tar->entry_linkpath));
1122 /* Parse out the numeric fields (all are octal) */
1123 archive_entry_set_mode(entry,
1124 (mode_t)tar_atol(header->mode, sizeof(header->mode)));
1125 archive_entry_set_uid(entry, tar_atol(header->uid, sizeof(header->uid)));
1126 archive_entry_set_gid(entry, tar_atol(header->gid, sizeof(header->gid)));
1127 tar->entry_bytes_remaining = tar_atol(header->size, sizeof(header->size));
1128 if (tar->entry_bytes_remaining < 0) {
1129 tar->entry_bytes_remaining = 0;
1130 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1131 "Tar entry has negative size?");
1134 tar->realsize = tar->entry_bytes_remaining;
1135 archive_entry_set_size(entry, tar->entry_bytes_remaining);
1136 archive_entry_set_mtime(entry, tar_atol(header->mtime, sizeof(header->mtime)), 0);
1138 /* Handle the tar type flag appropriately. */
1139 tartype = header->typeflag[0];
1142 case '1': /* Hard link */
1143 if (archive_entry_copy_hardlink_l(entry, tar->entry_linkpath.s,
1144 archive_strlen(&(tar->entry_linkpath)), tar->sconv) != 0) {
1145 err = set_conversion_failed_error(a, tar->sconv,
1147 if (err == ARCHIVE_FATAL)
1151 * The following may seem odd, but: Technically, tar
1152 * does not store the file type for a "hard link"
1153 * entry, only the fact that it is a hard link. So, I
1154 * leave the type zero normally. But, pax interchange
1155 * format allows hard links to have data, which
1156 * implies that the underlying entry is a regular
1159 if (archive_entry_size(entry) > 0)
1160 archive_entry_set_filetype(entry, AE_IFREG);
1163 * A tricky point: Traditionally, tar readers have
1164 * ignored the size field when reading hardlink
1165 * entries, and some writers put non-zero sizes even
1166 * though the body is empty. POSIX blessed this
1167 * convention in the 1988 standard, but broke with
1168 * this tradition in 2001 by permitting hardlink
1169 * entries to store valid bodies in pax interchange
1170 * format, but not in ustar format. Since there is no
1171 * hard and fast way to distinguish pax interchange
1172 * from earlier archives (the 'x' and 'g' entries are
1173 * optional, after all), we need a heuristic.
1175 if (archive_entry_size(entry) == 0) {
1176 /* If the size is already zero, we're done. */
1177 } else if (a->archive.archive_format
1178 == ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE) {
1179 /* Definitely pax extended; must obey hardlink size. */
1180 } else if (a->archive.archive_format == ARCHIVE_FORMAT_TAR
1181 || a->archive.archive_format == ARCHIVE_FORMAT_TAR_GNUTAR)
1183 /* Old-style or GNU tar: we must ignore the size. */
1184 archive_entry_set_size(entry, 0);
1185 tar->entry_bytes_remaining = 0;
1186 } else if (archive_read_format_tar_bid(a, 50) > 50) {
1188 * We don't know if it's pax: If the bid
1189 * function sees a valid ustar header
1190 * immediately following, then let's ignore
1191 * the hardlink size.
1193 archive_entry_set_size(entry, 0);
1194 tar->entry_bytes_remaining = 0;
1197 * TODO: There are still two cases I'd like to handle:
1198 * = a ustar non-pax archive with a hardlink entry at
1199 * end-of-archive. (Look for block of nulls following?)
1200 * = a pax archive that has not seen any pax headers
1201 * and has an entry which is a hardlink entry storing
1202 * a body containing an uncompressed tar archive.
1203 * The first is worth addressing; I don't see any reliable
1204 * way to deal with the second possibility.
1207 case '2': /* Symlink */
1208 archive_entry_set_filetype(entry, AE_IFLNK);
1209 archive_entry_set_size(entry, 0);
1210 tar->entry_bytes_remaining = 0;
1211 if (archive_entry_copy_symlink_l(entry, tar->entry_linkpath.s,
1212 archive_strlen(&(tar->entry_linkpath)), tar->sconv) != 0) {
1213 err = set_conversion_failed_error(a, tar->sconv,
1215 if (err == ARCHIVE_FATAL)
1219 case '3': /* Character device */
1220 archive_entry_set_filetype(entry, AE_IFCHR);
1221 archive_entry_set_size(entry, 0);
1222 tar->entry_bytes_remaining = 0;
1224 case '4': /* Block device */
1225 archive_entry_set_filetype(entry, AE_IFBLK);
1226 archive_entry_set_size(entry, 0);
1227 tar->entry_bytes_remaining = 0;
1230 archive_entry_set_filetype(entry, AE_IFDIR);
1231 archive_entry_set_size(entry, 0);
1232 tar->entry_bytes_remaining = 0;
1234 case '6': /* FIFO device */
1235 archive_entry_set_filetype(entry, AE_IFIFO);
1236 archive_entry_set_size(entry, 0);
1237 tar->entry_bytes_remaining = 0;
1239 case 'D': /* GNU incremental directory type */
1241 * No special handling is actually required here.
1242 * It might be nice someday to preprocess the file list and
1243 * provide it to the client, though.
1245 archive_entry_set_filetype(entry, AE_IFDIR);
1247 case 'M': /* GNU "Multi-volume" (remainder of file from last archive)*/
1249 * As far as I can tell, this is just like a regular file
1250 * entry, except that the contents should be _appended_ to
1251 * the indicated file at the indicated offset. This may
1252 * require some API work to fully support.
1255 case 'N': /* Old GNU "long filename" entry. */
1256 /* The body of this entry is a script for renaming
1257 * previously-extracted entries. Ugh. It will never
1258 * be supported by libarchive. */
1259 archive_entry_set_filetype(entry, AE_IFREG);
1261 case 'S': /* GNU sparse files */
1263 * Sparse files are really just regular files with
1264 * sparse information in the extended area.
1267 default: /* Regular file and non-standard types */
1269 * Per POSIX: non-recognized types should always be
1270 * treated as regular files.
1272 archive_entry_set_filetype(entry, AE_IFREG);
1279 * Parse out header elements for "old-style" tar archives.
1282 header_old_tar(struct archive_read *a, struct tar *tar,
1283 struct archive_entry *entry, const void *h)
1285 const struct archive_entry_header_ustar *header;
1286 int err = ARCHIVE_OK, err2;
1288 /* Copy filename over (to ensure null termination). */
1289 header = (const struct archive_entry_header_ustar *)h;
1290 if (archive_entry_copy_pathname_l(entry,
1291 header->name, sizeof(header->name), tar->sconv) != 0) {
1292 err = set_conversion_failed_error(a, tar->sconv, "Pathname");
1293 if (err == ARCHIVE_FATAL)
1297 /* Grab rest of common fields */
1298 err2 = header_common(a, tar, entry, h);
1302 tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1307 * Read a Mac AppleDouble-encoded blob of file metadata,
1311 read_mac_metadata_blob(struct archive_read *a, struct tar *tar,
1312 struct archive_entry *entry, const void *h, size_t *unconsumed)
1316 const char *p, *name;
1317 const wchar_t *wp, *wname;
1319 (void)h; /* UNUSED */
1321 wname = wp = archive_entry_pathname_w(entry);
1323 /* Find the last path element. */
1324 for (; *wp != L'\0'; ++wp) {
1325 if (wp[0] == '/' && wp[1] != L'\0')
1329 * If last path element starts with "._", then
1330 * this is a Mac extension.
1332 if (wname[0] != L'.' || wname[1] != L'_' || wname[2] == L'\0')
1335 /* Find the last path element. */
1336 name = p = archive_entry_pathname(entry);
1338 return (ARCHIVE_FAILED);
1339 for (; *p != '\0'; ++p) {
1340 if (p[0] == '/' && p[1] != '\0')
1344 * If last path element starts with "._", then
1345 * this is a Mac extension.
1347 if (name[0] != '.' || name[1] != '_' || name[2] == '\0')
1351 /* Read the body as a Mac OS metadata blob. */
1352 size = archive_entry_size(entry);
1355 * TODO: Look beyond the body here to peek at the next header.
1356 * If it's a regular header (not an extension header)
1357 * that has the wrong name, just return the current
1358 * entry as-is, without consuming the body here.
1359 * That would reduce the risk of us mis-identifying
1360 * an ordinary file that just happened to have
1361 * a name starting with "._".
1363 * Q: Is the above idea really possible? Even
1364 * when there are GNU or pax extension entries?
1366 data = __archive_read_ahead(a, (size_t)size, NULL);
1369 return (ARCHIVE_FATAL);
1371 archive_entry_copy_mac_metadata(entry, data, (size_t)size);
1372 *unconsumed = (size_t)((size + 511) & ~ 511);
1373 tar_flush_unconsumed(a, unconsumed);
1374 return (tar_read_header(a, tar, entry, unconsumed));
1378 * Parse a file header for a pax extended archive entry.
1381 header_pax_global(struct archive_read *a, struct tar *tar,
1382 struct archive_entry *entry, const void *h, size_t *unconsumed)
1386 err = read_body_to_string(a, tar, &(tar->pax_global), h, unconsumed);
1387 if (err != ARCHIVE_OK)
1389 err = tar_read_header(a, tar, entry, unconsumed);
1394 header_pax_extensions(struct archive_read *a, struct tar *tar,
1395 struct archive_entry *entry, const void *h, size_t *unconsumed)
1399 err = read_body_to_string(a, tar, &(tar->pax_header), h, unconsumed);
1400 if (err != ARCHIVE_OK)
1403 /* Parse the next header. */
1404 err = tar_read_header(a, tar, entry, unconsumed);
1405 if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
1409 * TODO: Parse global/default options into 'entry' struct here
1410 * before handling file-specific options.
1412 * This design (parse standard header, then overwrite with pax
1413 * extended attribute data) usually works well, but isn't ideal;
1414 * it would be better to parse the pax extended attributes first
1415 * and then skip any fields in the standard header that were
1416 * defined in the pax header.
1418 err2 = pax_header(a, tar, entry, tar->pax_header.s);
1419 err = err_combine(err, err2);
1420 tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1426 * Parse a file header for a Posix "ustar" archive entry. This also
1427 * handles "pax" or "extended ustar" entries.
1430 header_ustar(struct archive_read *a, struct tar *tar,
1431 struct archive_entry *entry, const void *h)
1433 const struct archive_entry_header_ustar *header;
1434 struct archive_string *as;
1435 int err = ARCHIVE_OK, r;
1437 header = (const struct archive_entry_header_ustar *)h;
1439 /* Copy name into an internal buffer to ensure null-termination. */
1440 as = &(tar->entry_pathname);
1441 if (header->prefix[0]) {
1442 archive_strncpy(as, header->prefix, sizeof(header->prefix));
1443 if (as->s[archive_strlen(as) - 1] != '/')
1444 archive_strappend_char(as, '/');
1445 archive_strncat(as, header->name, sizeof(header->name));
1447 archive_strncpy(as, header->name, sizeof(header->name));
1449 if (archive_entry_copy_pathname_l(entry, as->s, archive_strlen(as),
1451 err = set_conversion_failed_error(a, tar->sconv, "Pathname");
1452 if (err == ARCHIVE_FATAL)
1456 /* Handle rest of common fields. */
1457 r = header_common(a, tar, entry, h);
1458 if (r == ARCHIVE_FATAL)
1463 /* Handle POSIX ustar fields. */
1464 if (archive_entry_copy_uname_l(entry,
1465 header->uname, sizeof(header->uname), tar->sconv) != 0) {
1466 err = set_conversion_failed_error(a, tar->sconv, "Uname");
1467 if (err == ARCHIVE_FATAL)
1471 if (archive_entry_copy_gname_l(entry,
1472 header->gname, sizeof(header->gname), tar->sconv) != 0) {
1473 err = set_conversion_failed_error(a, tar->sconv, "Gname");
1474 if (err == ARCHIVE_FATAL)
1478 /* Parse out device numbers only for char and block specials. */
1479 if (header->typeflag[0] == '3' || header->typeflag[0] == '4') {
1480 archive_entry_set_rdevmajor(entry, (dev_t)
1481 tar_atol(header->rdevmajor, sizeof(header->rdevmajor)));
1482 archive_entry_set_rdevminor(entry, (dev_t)
1483 tar_atol(header->rdevminor, sizeof(header->rdevminor)));
1486 tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1493 * Parse the pax extended attributes record.
1495 * Returns non-zero if there's an error in the data.
1498 pax_header(struct archive_read *a, struct tar *tar,
1499 struct archive_entry *entry, char *attr)
1501 size_t attr_length, l, line_length;
1504 struct archive_string *as;
1505 struct archive_string_conv *sconv;
1508 attr_length = strlen(attr);
1509 tar->pax_hdrcharset_binary = 0;
1510 archive_string_empty(&(tar->entry_gname));
1511 archive_string_empty(&(tar->entry_linkpath));
1512 archive_string_empty(&(tar->entry_pathname));
1513 archive_string_empty(&(tar->entry_pathname_override));
1514 archive_string_empty(&(tar->entry_uname));
1516 while (attr_length > 0) {
1517 /* Parse decimal length field at start of line. */
1520 p = attr; /* Record start of line. */
1527 if (*p < '0' || *p > '9') {
1528 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1529 "Ignoring malformed pax extended attributes");
1530 return (ARCHIVE_WARN);
1533 line_length += *p - '0';
1534 if (line_length > 999999) {
1535 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1536 "Rejecting pax extended attribute > 1MB");
1537 return (ARCHIVE_WARN);
1544 * Parsed length must be no bigger than available data,
1545 * at least 1, and the last character of the line must
1548 if (line_length > attr_length
1550 || attr[line_length - 1] != '\n')
1552 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1553 "Ignoring malformed pax extended attribute");
1554 return (ARCHIVE_WARN);
1557 /* Null-terminate the line. */
1558 attr[line_length - 1] = '\0';
1560 /* Find end of key and null terminate it. */
1564 while (*p && *p != '=')
1567 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1568 "Invalid pax extended attributes");
1569 return (ARCHIVE_WARN);
1573 /* Identify null-terminated 'value' portion. */
1576 /* Identify this attribute and set it in the entry. */
1577 err2 = pax_attribute(a, tar, entry, key, value);
1578 if (err2 == ARCHIVE_FATAL)
1580 err = err_combine(err, err2);
1582 /* Skip to next line */
1583 attr += line_length;
1584 attr_length -= line_length;
1588 * PAX format uses UTF-8 as default charset for its metadata
1589 * unless hdrcharset=BINARY is present in its header.
1590 * We apply the charset specified by the hdrcharset option only
1591 * when the hdrcharset attribute(in PAX header) is BINARY because
1592 * we respect the charset described in PAX header and BINARY also
1593 * means that metadata(filename,uname and gname) character-set
1596 if (tar->pax_hdrcharset_binary)
1597 sconv = tar->opt_sconv;
1599 sconv = archive_string_conversion_from_charset(
1600 &(a->archive), "UTF-8", 1);
1602 return (ARCHIVE_FATAL);
1604 archive_string_conversion_set_opt(sconv,
1605 SCONV_SET_OPT_UTF8_LIBARCHIVE2X);
1608 if (archive_strlen(&(tar->entry_gname)) > 0) {
1609 if (archive_entry_copy_gname_l(entry, tar->entry_gname.s,
1610 archive_strlen(&(tar->entry_gname)), sconv) != 0) {
1611 err = set_conversion_failed_error(a, sconv, "Gname");
1612 if (err == ARCHIVE_FATAL)
1614 /* Use a converted an original name. */
1615 archive_entry_copy_gname(entry, tar->entry_gname.s);
1618 if (archive_strlen(&(tar->entry_linkpath)) > 0) {
1619 if (archive_entry_copy_link_l(entry, tar->entry_linkpath.s,
1620 archive_strlen(&(tar->entry_linkpath)), sconv) != 0) {
1621 err = set_conversion_failed_error(a, sconv, "Linkname");
1622 if (err == ARCHIVE_FATAL)
1624 /* Use a converted an original name. */
1625 archive_entry_copy_link(entry, tar->entry_linkpath.s);
1629 * Some extensions (such as the GNU sparse file extensions)
1630 * deliberately store a synthetic name under the regular 'path'
1631 * attribute and the real file name under a different attribute.
1632 * Since we're supposed to not care about the order, we
1633 * have no choice but to store all of the various filenames
1634 * we find and figure it all out afterwards. This is the
1635 * figuring out part.
1638 if (archive_strlen(&(tar->entry_pathname_override)) > 0)
1639 as = &(tar->entry_pathname_override);
1640 else if (archive_strlen(&(tar->entry_pathname)) > 0)
1641 as = &(tar->entry_pathname);
1643 if (archive_entry_copy_pathname_l(entry, as->s,
1644 archive_strlen(as), sconv) != 0) {
1645 err = set_conversion_failed_error(a, sconv, "Pathname");
1646 if (err == ARCHIVE_FATAL)
1648 /* Use a converted an original name. */
1649 archive_entry_copy_pathname(entry, as->s);
1652 if (archive_strlen(&(tar->entry_uname)) > 0) {
1653 if (archive_entry_copy_uname_l(entry, tar->entry_uname.s,
1654 archive_strlen(&(tar->entry_uname)), sconv) != 0) {
1655 err = set_conversion_failed_error(a, sconv, "Uname");
1656 if (err == ARCHIVE_FATAL)
1658 /* Use a converted an original name. */
1659 archive_entry_copy_uname(entry, tar->entry_uname.s);
1666 pax_attribute_xattr(struct archive_entry *entry,
1667 const char *name, const char *value)
1670 void *value_decoded;
1673 if (strlen(name) < 18 || (memcmp(name, "LIBARCHIVE.xattr.", 17)) != 0)
1678 /* URL-decode name */
1679 name_decoded = url_decode(name);
1680 if (name_decoded == NULL)
1683 /* Base-64 decode value */
1684 value_decoded = base64_decode(value, strlen(value), &value_len);
1685 if (value_decoded == NULL) {
1690 archive_entry_xattr_add_entry(entry, name_decoded,
1691 value_decoded, value_len);
1694 free(value_decoded);
1699 * Parse a single key=value attribute. key/value pointers are
1700 * assumed to point into reasonably long-lived storage.
1702 * Note that POSIX reserves all-lowercase keywords. Vendor-specific
1703 * extensions should always have keywords of the form "VENDOR.attribute"
1704 * In particular, it's quite feasible to support many different
1705 * vendor extensions here. I'm using "LIBARCHIVE" for extensions
1706 * unique to this library.
1708 * Investigate other vendor-specific extensions and see if
1709 * any of them look useful.
1712 pax_attribute(struct archive_read *a, struct tar *tar,
1713 struct archive_entry *entry, const char *key, const char *value)
1717 int err = ARCHIVE_OK, r;
1721 value = ""; /* Disable compiler warning; do not pass
1722 * NULL pointer to strlen(). */
1726 /* GNU "0.0" sparse pax format. */
1727 if (strcmp(key, "GNU.sparse.numblocks") == 0) {
1728 tar->sparse_offset = -1;
1729 tar->sparse_numbytes = -1;
1730 tar->sparse_gnu_major = 0;
1731 tar->sparse_gnu_minor = 0;
1733 if (strcmp(key, "GNU.sparse.offset") == 0) {
1734 tar->sparse_offset = tar_atol10(value, strlen(value));
1735 if (tar->sparse_numbytes != -1) {
1736 if (gnu_add_sparse_entry(a, tar,
1737 tar->sparse_offset, tar->sparse_numbytes)
1739 return (ARCHIVE_FATAL);
1740 tar->sparse_offset = -1;
1741 tar->sparse_numbytes = -1;
1744 if (strcmp(key, "GNU.sparse.numbytes") == 0) {
1745 tar->sparse_numbytes = tar_atol10(value, strlen(value));
1746 if (tar->sparse_numbytes != -1) {
1747 if (gnu_add_sparse_entry(a, tar,
1748 tar->sparse_offset, tar->sparse_numbytes)
1750 return (ARCHIVE_FATAL);
1751 tar->sparse_offset = -1;
1752 tar->sparse_numbytes = -1;
1755 if (strcmp(key, "GNU.sparse.size") == 0) {
1756 tar->realsize = tar_atol10(value, strlen(value));
1757 archive_entry_set_size(entry, tar->realsize);
1760 /* GNU "0.1" sparse pax format. */
1761 if (strcmp(key, "GNU.sparse.map") == 0) {
1762 tar->sparse_gnu_major = 0;
1763 tar->sparse_gnu_minor = 1;
1764 if (gnu_sparse_01_parse(a, tar, value) != ARCHIVE_OK)
1765 return (ARCHIVE_WARN);
1768 /* GNU "1.0" sparse pax format */
1769 if (strcmp(key, "GNU.sparse.major") == 0) {
1770 tar->sparse_gnu_major = (int)tar_atol10(value, strlen(value));
1771 tar->sparse_gnu_pending = 1;
1773 if (strcmp(key, "GNU.sparse.minor") == 0) {
1774 tar->sparse_gnu_minor = (int)tar_atol10(value, strlen(value));
1775 tar->sparse_gnu_pending = 1;
1777 if (strcmp(key, "GNU.sparse.name") == 0) {
1779 * The real filename; when storing sparse
1780 * files, GNU tar puts a synthesized name into
1781 * the regular 'path' attribute in an attempt
1782 * to limit confusion. ;-)
1784 archive_strcpy(&(tar->entry_pathname_override), value);
1786 if (strcmp(key, "GNU.sparse.realsize") == 0) {
1787 tar->realsize = tar_atol10(value, strlen(value));
1788 archive_entry_set_size(entry, tar->realsize);
1792 /* Our extensions */
1793 /* TODO: Handle arbitrary extended attributes... */
1795 if (strcmp(key, "LIBARCHIVE.xxxxxxx") == 0)
1796 archive_entry_set_xxxxxx(entry, value);
1798 if (strcmp(key, "LIBARCHIVE.creationtime") == 0) {
1799 pax_time(value, &s, &n);
1800 archive_entry_set_birthtime(entry, s, n);
1802 if (memcmp(key, "LIBARCHIVE.xattr.", 17) == 0)
1803 pax_attribute_xattr(entry, key, value);
1806 /* We support some keys used by the "star" archiver */
1807 if (strcmp(key, "SCHILY.acl.access") == 0) {
1808 if (tar->sconv_acl == NULL) {
1810 archive_string_conversion_from_charset(
1811 &(a->archive), "UTF-8", 1);
1812 if (tar->sconv_acl == NULL)
1813 return (ARCHIVE_FATAL);
1816 r = archive_acl_parse_l(archive_entry_acl(entry),
1817 value, ARCHIVE_ENTRY_ACL_TYPE_ACCESS,
1819 if (r != ARCHIVE_OK) {
1821 if (err == ARCHIVE_FATAL) {
1822 archive_set_error(&a->archive, ENOMEM,
1823 "Can't allocate memory for "
1824 "SCHILY.acl.access");
1827 archive_set_error(&a->archive,
1829 "Parse error: SCHILY.acl.access");
1831 } else if (strcmp(key, "SCHILY.acl.default") == 0) {
1832 if (tar->sconv_acl == NULL) {
1834 archive_string_conversion_from_charset(
1835 &(a->archive), "UTF-8", 1);
1836 if (tar->sconv_acl == NULL)
1837 return (ARCHIVE_FATAL);
1840 r = archive_acl_parse_l(archive_entry_acl(entry),
1841 value, ARCHIVE_ENTRY_ACL_TYPE_DEFAULT,
1843 if (r != ARCHIVE_OK) {
1845 if (err == ARCHIVE_FATAL) {
1846 archive_set_error(&a->archive, ENOMEM,
1847 "Can't allocate memory for "
1848 "SCHILY.acl.default");
1851 archive_set_error(&a->archive,
1853 "Parse error: SCHILY.acl.default");
1855 } else if (strcmp(key, "SCHILY.devmajor") == 0) {
1856 archive_entry_set_rdevmajor(entry,
1857 (dev_t)tar_atol10(value, strlen(value)));
1858 } else if (strcmp(key, "SCHILY.devminor") == 0) {
1859 archive_entry_set_rdevminor(entry,
1860 (dev_t)tar_atol10(value, strlen(value)));
1861 } else if (strcmp(key, "SCHILY.fflags") == 0) {
1862 archive_entry_copy_fflags_text(entry, value);
1863 } else if (strcmp(key, "SCHILY.dev") == 0) {
1864 archive_entry_set_dev(entry,
1865 (dev_t)tar_atol10(value, strlen(value)));
1866 } else if (strcmp(key, "SCHILY.ino") == 0) {
1867 archive_entry_set_ino(entry,
1868 tar_atol10(value, strlen(value)));
1869 } else if (strcmp(key, "SCHILY.nlink") == 0) {
1870 archive_entry_set_nlink(entry, (unsigned)
1871 tar_atol10(value, strlen(value)));
1872 } else if (strcmp(key, "SCHILY.realsize") == 0) {
1873 tar->realsize = tar_atol10(value, strlen(value));
1874 archive_entry_set_size(entry, tar->realsize);
1875 } else if (strcmp(key, "SUN.holesdata") == 0) {
1876 /* A Solaris extension for sparse. */
1877 r = solaris_sparse_parse(a, tar, entry, value);
1879 if (r == ARCHIVE_FATAL)
1882 archive_set_error(&a->archive,
1884 "Parse error: SUN.holesdata");
1889 if (strcmp(key, "atime") == 0) {
1890 pax_time(value, &s, &n);
1891 archive_entry_set_atime(entry, s, n);
1895 if (strcmp(key, "ctime") == 0) {
1896 pax_time(value, &s, &n);
1897 archive_entry_set_ctime(entry, s, n);
1898 } else if (strcmp(key, "charset") == 0) {
1899 /* TODO: Publish charset information in entry. */
1900 } else if (strcmp(key, "comment") == 0) {
1901 /* TODO: Publish comment in entry. */
1905 if (strcmp(key, "gid") == 0) {
1906 archive_entry_set_gid(entry,
1907 tar_atol10(value, strlen(value)));
1908 } else if (strcmp(key, "gname") == 0) {
1909 archive_strcpy(&(tar->entry_gname), value);
1913 if (strcmp(key, "hdrcharset") == 0) {
1914 if (strcmp(value, "BINARY") == 0)
1916 tar->pax_hdrcharset_binary = 1;
1917 else if (strcmp(value, "ISO-IR 10646 2000 UTF-8") == 0)
1918 tar->pax_hdrcharset_binary = 0;
1922 /* pax interchange doesn't distinguish hardlink vs. symlink. */
1923 if (strcmp(key, "linkpath") == 0) {
1924 archive_strcpy(&(tar->entry_linkpath), value);
1928 if (strcmp(key, "mtime") == 0) {
1929 pax_time(value, &s, &n);
1930 archive_entry_set_mtime(entry, s, n);
1934 if (strcmp(key, "path") == 0) {
1935 archive_strcpy(&(tar->entry_pathname), value);
1939 /* POSIX has reserved 'realtime.*' */
1942 /* POSIX has reserved 'security.*' */
1943 /* Someday: if (strcmp(key, "security.acl") == 0) { ... } */
1944 if (strcmp(key, "size") == 0) {
1945 /* "size" is the size of the data in the entry. */
1946 tar->entry_bytes_remaining
1947 = tar_atol10(value, strlen(value));
1949 * But, "size" is not necessarily the size of
1950 * the file on disk; if this is a sparse file,
1951 * the disk size may have already been set from
1952 * GNU.sparse.realsize or GNU.sparse.size or
1953 * an old GNU header field or SCHILY.realsize
1956 if (tar->realsize < 0) {
1957 archive_entry_set_size(entry,
1958 tar->entry_bytes_remaining);
1960 = tar->entry_bytes_remaining;
1965 if (strcmp(key, "uid") == 0) {
1966 archive_entry_set_uid(entry,
1967 tar_atol10(value, strlen(value)));
1968 } else if (strcmp(key, "uname") == 0) {
1969 archive_strcpy(&(tar->entry_uname), value);
1979 * parse a decimal time value, which may include a fractional portion
1982 pax_time(const char *p, int64_t *ps, long *pn)
1988 int64_t limit, last_digit_limit;
1990 limit = INT64_MAX / 10;
1991 last_digit_limit = INT64_MAX % 10;
1999 while (*p >= '0' && *p <= '9') {
2002 (s == limit && digit > last_digit_limit)) {
2006 s = (s * 10) + digit;
2012 /* Calculate nanoseconds. */
2021 if (*p >= '0' && *p <= '9')
2022 *pn += (*p - '0') * l;
2029 * Parse GNU tar header
2032 header_gnutar(struct archive_read *a, struct tar *tar,
2033 struct archive_entry *entry, const void *h, size_t *unconsumed)
2035 const struct archive_entry_header_gnutar *header;
2037 int err = ARCHIVE_OK;
2040 * GNU header is like POSIX ustar, except 'prefix' is
2041 * replaced with some other fields. This also means the
2042 * filename is stored as in old-style archives.
2045 /* Grab fields common to all tar variants. */
2046 err = header_common(a, tar, entry, h);
2047 if (err == ARCHIVE_FATAL)
2050 /* Copy filename over (to ensure null termination). */
2051 header = (const struct archive_entry_header_gnutar *)h;
2052 if (archive_entry_copy_pathname_l(entry,
2053 header->name, sizeof(header->name), tar->sconv) != 0) {
2054 err = set_conversion_failed_error(a, tar->sconv, "Pathname");
2055 if (err == ARCHIVE_FATAL)
2059 /* Fields common to ustar and GNU */
2060 /* XXX Can the following be factored out since it's common
2061 * to ustar and gnu tar? Is it okay to move it down into
2062 * header_common, perhaps? */
2063 if (archive_entry_copy_uname_l(entry,
2064 header->uname, sizeof(header->uname), tar->sconv) != 0) {
2065 err = set_conversion_failed_error(a, tar->sconv, "Uname");
2066 if (err == ARCHIVE_FATAL)
2070 if (archive_entry_copy_gname_l(entry,
2071 header->gname, sizeof(header->gname), tar->sconv) != 0) {
2072 err = set_conversion_failed_error(a, tar->sconv, "Gname");
2073 if (err == ARCHIVE_FATAL)
2077 /* Parse out device numbers only for char and block specials */
2078 if (header->typeflag[0] == '3' || header->typeflag[0] == '4') {
2079 archive_entry_set_rdevmajor(entry, (dev_t)
2080 tar_atol(header->rdevmajor, sizeof(header->rdevmajor)));
2081 archive_entry_set_rdevminor(entry, (dev_t)
2082 tar_atol(header->rdevminor, sizeof(header->rdevminor)));
2084 archive_entry_set_rdev(entry, 0);
2086 tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
2088 /* Grab GNU-specific fields. */
2089 t = tar_atol(header->atime, sizeof(header->atime));
2091 archive_entry_set_atime(entry, t, 0);
2092 t = tar_atol(header->ctime, sizeof(header->ctime));
2094 archive_entry_set_ctime(entry, t, 0);
2096 if (header->realsize[0] != 0) {
2098 = tar_atol(header->realsize, sizeof(header->realsize));
2099 archive_entry_set_size(entry, tar->realsize);
2102 if (header->sparse[0].offset[0] != 0) {
2103 if (gnu_sparse_old_read(a, tar, header, unconsumed)
2105 return (ARCHIVE_FATAL);
2107 if (header->isextended[0] != 0) {
2116 gnu_add_sparse_entry(struct archive_read *a, struct tar *tar,
2117 int64_t offset, int64_t remaining)
2119 struct sparse_block *p;
2121 p = (struct sparse_block *)malloc(sizeof(*p));
2123 archive_set_error(&a->archive, ENOMEM, "Out of memory");
2124 return (ARCHIVE_FATAL);
2126 memset(p, 0, sizeof(*p));
2127 if (tar->sparse_last != NULL)
2128 tar->sparse_last->next = p;
2130 tar->sparse_list = p;
2131 tar->sparse_last = p;
2132 if (remaining < 0 || offset < 0) {
2133 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC, "Malformed sparse map data");
2134 return (ARCHIVE_FATAL);
2137 p->remaining = remaining;
2138 return (ARCHIVE_OK);
2142 gnu_clear_sparse_list(struct tar *tar)
2144 struct sparse_block *p;
2146 while (tar->sparse_list != NULL) {
2147 p = tar->sparse_list;
2148 tar->sparse_list = p->next;
2151 tar->sparse_last = NULL;
2155 * GNU tar old-format sparse data.
2157 * GNU old-format sparse data is stored in a fixed-field
2158 * format. Offset/size values are 11-byte octal fields (same
2159 * format as 'size' field in ustart header). These are
2160 * stored in the header, allocating subsequent header blocks
2161 * as needed. Extending the header in this way is a pretty
2162 * severe POSIX violation; this design has earned GNU tar a
2167 gnu_sparse_old_read(struct archive_read *a, struct tar *tar,
2168 const struct archive_entry_header_gnutar *header, size_t *unconsumed)
2173 struct gnu_sparse sparse[21];
2177 const struct extended *ext;
2179 if (gnu_sparse_old_parse(a, tar, header->sparse, 4) != ARCHIVE_OK)
2180 return (ARCHIVE_FATAL);
2181 if (header->isextended[0] == 0)
2182 return (ARCHIVE_OK);
2185 tar_flush_unconsumed(a, unconsumed);
2186 data = __archive_read_ahead(a, 512, &bytes_read);
2188 return (ARCHIVE_FATAL);
2189 if (bytes_read < 512) {
2190 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2191 "Truncated tar archive "
2192 "detected while reading sparse file data");
2193 return (ARCHIVE_FATAL);
2196 ext = (const struct extended *)data;
2197 if (gnu_sparse_old_parse(a, tar, ext->sparse, 21) != ARCHIVE_OK)
2198 return (ARCHIVE_FATAL);
2199 } while (ext->isextended[0] != 0);
2200 if (tar->sparse_list != NULL)
2201 tar->entry_offset = tar->sparse_list->offset;
2202 return (ARCHIVE_OK);
2206 gnu_sparse_old_parse(struct archive_read *a, struct tar *tar,
2207 const struct gnu_sparse *sparse, int length)
2209 while (length > 0 && sparse->offset[0] != 0) {
2210 if (gnu_add_sparse_entry(a, tar,
2211 tar_atol(sparse->offset, sizeof(sparse->offset)),
2212 tar_atol(sparse->numbytes, sizeof(sparse->numbytes)))
2214 return (ARCHIVE_FATAL);
2218 return (ARCHIVE_OK);
2222 * GNU tar sparse format 0.0
2224 * Beginning with GNU tar 1.15, sparse files are stored using
2225 * information in the pax extended header. The GNU tar maintainers
2226 * have gone through a number of variations in the process of working
2227 * out this scheme; fortunately, they're all numbered.
2229 * Sparse format 0.0 uses attribute GNU.sparse.numblocks to store the
2230 * number of blocks, and GNU.sparse.offset/GNU.sparse.numbytes to
2231 * store offset/size for each block. The repeated instances of these
2232 * latter fields violate the pax specification (which frowns on
2233 * duplicate keys), so this format was quickly replaced.
2237 * GNU tar sparse format 0.1
2239 * This version replaced the offset/numbytes attributes with
2240 * a single "map" attribute that stored a list of integers. This
2241 * format had two problems: First, the "map" attribute could be very
2242 * long, which caused problems for some implementations. More
2243 * importantly, the sparse data was lost when extracted by archivers
2244 * that didn't recognize this extension.
2248 gnu_sparse_01_parse(struct archive_read *a, struct tar *tar, const char *p)
2251 int64_t offset = -1, size = -1;
2255 while (*e != '\0' && *e != ',') {
2256 if (*e < '0' || *e > '9')
2257 return (ARCHIVE_WARN);
2261 offset = tar_atol10(p, e - p);
2263 return (ARCHIVE_WARN);
2265 size = tar_atol10(p, e - p);
2267 return (ARCHIVE_WARN);
2268 if (gnu_add_sparse_entry(a, tar, offset, size)
2270 return (ARCHIVE_FATAL);
2274 return (ARCHIVE_OK);
2280 * GNU tar sparse format 1.0
2282 * The idea: The offset/size data is stored as a series of base-10
2283 * ASCII numbers prepended to the file data, so that dearchivers that
2284 * don't support this format will extract the block map along with the
2285 * data and a separate post-process can restore the sparseness.
2287 * Unfortunately, GNU tar 1.16 had a bug that added unnecessary
2288 * padding to the body of the file when using this format. GNU tar
2289 * 1.17 corrected this bug without bumping the version number, so
2290 * it's not possible to support both variants. This code supports
2291 * the later variant at the expense of not supporting the former.
2293 * This variant also replaced GNU.sparse.size with GNU.sparse.realsize
2294 * and introduced the GNU.sparse.major/GNU.sparse.minor attributes.
2298 * Read the next line from the input, and parse it as a decimal
2299 * integer followed by '\n'. Returns positive integer value or
2300 * negative on error.
2303 gnu_sparse_10_atol(struct archive_read *a, struct tar *tar,
2304 int64_t *remaining, size_t *unconsumed)
2306 int64_t l, limit, last_digit_limit;
2312 limit = INT64_MAX / base;
2313 last_digit_limit = INT64_MAX % base;
2316 * Skip any lines starting with '#'; GNU tar specs
2317 * don't require this, but they should.
2320 bytes_read = readline(a, tar, &p,
2321 (ssize_t)tar_min(*remaining, 100), unconsumed);
2322 if (bytes_read <= 0)
2323 return (ARCHIVE_FATAL);
2324 *remaining -= bytes_read;
2325 } while (p[0] == '#');
2328 while (bytes_read > 0) {
2331 if (*p < '0' || *p >= '0' + base)
2332 return (ARCHIVE_WARN);
2334 if (l > limit || (l == limit && digit > last_digit_limit))
2335 l = INT64_MAX; /* Truncate on overflow. */
2337 l = (l * base) + digit;
2341 /* TODO: Error message. */
2342 return (ARCHIVE_WARN);
2346 * Returns length (in bytes) of the sparse data description
2350 gnu_sparse_10_read(struct archive_read *a, struct tar *tar, size_t *unconsumed)
2354 int64_t offset, size, to_skip, remaining;
2356 /* Clear out the existing sparse list. */
2357 gnu_clear_sparse_list(tar);
2359 remaining = tar->entry_bytes_remaining;
2361 /* Parse entries. */
2362 entries = (int)gnu_sparse_10_atol(a, tar, &remaining, unconsumed);
2364 return (ARCHIVE_FATAL);
2365 /* Parse the individual entries. */
2366 while (entries-- > 0) {
2367 /* Parse offset/size */
2368 offset = gnu_sparse_10_atol(a, tar, &remaining, unconsumed);
2370 return (ARCHIVE_FATAL);
2371 size = gnu_sparse_10_atol(a, tar, &remaining, unconsumed);
2373 return (ARCHIVE_FATAL);
2374 /* Add a new sparse entry. */
2375 if (gnu_add_sparse_entry(a, tar, offset, size) != ARCHIVE_OK)
2376 return (ARCHIVE_FATAL);
2378 /* Skip rest of block... */
2379 tar_flush_unconsumed(a, unconsumed);
2380 bytes_read = (ssize_t)(tar->entry_bytes_remaining - remaining);
2381 to_skip = 0x1ff & -bytes_read;
2382 if (to_skip != __archive_read_consume(a, to_skip))
2383 return (ARCHIVE_FATAL);
2384 return ((ssize_t)(bytes_read + to_skip));
2388 * Solaris pax extension for a sparse file. This is recorded with the
2389 * data and hole pairs. The way recording sparse information by Solaris'
2390 * pax simply indicates where data and sparse are, so the stored contents
2391 * consist of both data and hole.
2394 solaris_sparse_parse(struct archive_read *a, struct tar *tar,
2395 struct archive_entry *entry, const char *p)
2401 (void)entry; /* UNUSED */
2407 return (ARCHIVE_WARN);
2410 while (*e != '\0' && *e != ' ') {
2411 if (*e < '0' || *e > '9')
2412 return (ARCHIVE_WARN);
2416 end = tar_atol10(p, e - p);
2418 return (ARCHIVE_WARN);
2420 if (gnu_add_sparse_entry(a, tar, start,
2421 end - start) != ARCHIVE_OK)
2422 return (ARCHIVE_FATAL);
2423 tar->sparse_last->hole = hole;
2426 return (ARCHIVE_OK);
2433 * Convert text->integer.
2435 * Traditional tar formats (including POSIX) specify base-8 for
2436 * all of the standard numeric fields. This is a significant limitation
2438 * = file size is limited to 8GB
2439 * = rdevmajor and rdevminor are limited to 21 bits
2440 * = uid/gid are limited to 21 bits
2442 * There are two workarounds for this:
2443 * = pax extended headers, which use variable-length string fields
2444 * = GNU tar and STAR both allow either base-8 or base-256 in
2445 * most fields. The high bit is set to indicate base-256.
2447 * On read, this implementation supports both extensions.
2450 tar_atol(const char *p, size_t char_cnt)
2453 * Technically, GNU tar considers a field to be in base-256
2454 * only if the first byte is 0xff or 0x80.
2457 return (tar_atol256(p, char_cnt));
2458 return (tar_atol8(p, char_cnt));
2462 * Note that this implementation does not (and should not!) obey
2463 * locale settings; you cannot simply substitute strtol here, since
2464 * it does obey locale.
2467 tar_atol_base_n(const char *p, size_t char_cnt, int base)
2469 int64_t l, maxval, limit, last_digit_limit;
2473 limit = INT64_MAX / base;
2474 last_digit_limit = INT64_MAX % base;
2476 /* the pointer will not be dereferenced if char_cnt is zero
2477 * due to the way the && operator is evaulated.
2479 while (char_cnt != 0 && (*p == ' ' || *p == '\t')) {
2485 if (char_cnt != 0 && *p == '-') {
2491 limit = -(INT64_MIN / base);
2492 last_digit_limit = INT64_MIN % base;
2496 if (char_cnt != 0) {
2498 while (digit >= 0 && digit < base && char_cnt != 0) {
2499 if (l>limit || (l == limit && digit > last_digit_limit)) {
2500 return maxval; /* Truncate on overflow. */
2502 l = (l * base) + digit;
2507 return (sign < 0) ? -l : l;
2511 tar_atol8(const char *p, size_t char_cnt)
2513 return tar_atol_base_n(p, char_cnt, 8);
2517 tar_atol10(const char *p, size_t char_cnt)
2519 return tar_atol_base_n(p, char_cnt, 10);
2523 * Parse a base-256 integer. This is just a variable-length
2524 * twos-complement signed binary value in big-endian order, except
2525 * that the high-order bit is ignored. The values here can be up to
2526 * 12 bytes, so we need to be careful about overflowing 64-bit
2527 * (8-byte) integers.
2529 * This code unashamedly assumes that the local machine uses 8-bit
2530 * bytes and twos-complement arithmetic.
2533 tar_atol256(const char *_p, size_t char_cnt)
2536 const unsigned char *p = (const unsigned char *)_p;
2537 unsigned char c, neg;
2539 /* Extend 7-bit 2s-comp to 8-bit 2s-comp, decide sign. */
2544 l = ~ARCHIVE_LITERAL_ULL(0);
2551 /* If more than 8 bytes, check that we can ignore
2552 * high-order bits without overflow. */
2553 while (char_cnt > sizeof(int64_t)) {
2556 return neg ? INT64_MIN : INT64_MAX;
2560 /* c is first byte that fits; if sign mismatch, return overflow */
2561 if ((c ^ neg) & 0x80) {
2562 return neg ? INT64_MIN : INT64_MAX;
2565 /* Accumulate remaining bytes. */
2566 while (--char_cnt > 0) {
2571 /* Return signed twos-complement value. */
2572 return (int64_t)(l);
2576 * Returns length of line (including trailing newline)
2577 * or negative on error. 'start' argument is updated to
2578 * point to first character of line. This avoids copying
2582 readline(struct archive_read *a, struct tar *tar, const char **start,
2583 ssize_t limit, size_t *unconsumed)
2586 ssize_t total_size = 0;
2591 tar_flush_unconsumed(a, unconsumed);
2593 t = __archive_read_ahead(a, 1, &bytes_read);
2594 if (bytes_read <= 0)
2595 return (ARCHIVE_FATAL);
2596 s = t; /* Start of line? */
2597 p = memchr(t, '\n', bytes_read);
2598 /* If we found '\n' in the read buffer, return pointer to that. */
2600 bytes_read = 1 + ((const char *)p) - s;
2601 if (bytes_read > limit) {
2602 archive_set_error(&a->archive,
2603 ARCHIVE_ERRNO_FILE_FORMAT,
2605 return (ARCHIVE_FATAL);
2607 *unconsumed = bytes_read;
2609 return (bytes_read);
2611 *unconsumed = bytes_read;
2612 /* Otherwise, we need to accumulate in a line buffer. */
2614 if (total_size + bytes_read > limit) {
2615 archive_set_error(&a->archive,
2616 ARCHIVE_ERRNO_FILE_FORMAT,
2618 return (ARCHIVE_FATAL);
2620 if (archive_string_ensure(&tar->line, total_size + bytes_read) == NULL) {
2621 archive_set_error(&a->archive, ENOMEM,
2622 "Can't allocate working buffer");
2623 return (ARCHIVE_FATAL);
2625 memcpy(tar->line.s + total_size, t, bytes_read);
2626 tar_flush_unconsumed(a, unconsumed);
2627 total_size += bytes_read;
2628 /* If we found '\n', clean up and return. */
2630 *start = tar->line.s;
2631 return (total_size);
2633 /* Read some more. */
2634 t = __archive_read_ahead(a, 1, &bytes_read);
2635 if (bytes_read <= 0)
2636 return (ARCHIVE_FATAL);
2637 s = t; /* Start of line? */
2638 p = memchr(t, '\n', bytes_read);
2639 /* If we found '\n', trim the read. */
2641 bytes_read = 1 + ((const char *)p) - s;
2643 *unconsumed = bytes_read;
2648 * base64_decode - Base64 decode
2650 * This accepts most variations of base-64 encoding, including:
2651 * * with or without line breaks
2652 * * with or without the final group padded with '=' or '_' characters
2653 * (The most economical Base-64 variant does not pad the last group and
2654 * omits line breaks; RFC1341 used for MIME requires both.)
2657 base64_decode(const char *s, size_t len, size_t *out_len)
2659 static const unsigned char digits[64] = {
2660 'A','B','C','D','E','F','G','H','I','J','K','L','M','N',
2661 'O','P','Q','R','S','T','U','V','W','X','Y','Z','a','b',
2662 'c','d','e','f','g','h','i','j','k','l','m','n','o','p',
2663 'q','r','s','t','u','v','w','x','y','z','0','1','2','3',
2664 '4','5','6','7','8','9','+','/' };
2665 static unsigned char decode_table[128];
2667 const unsigned char *src = (const unsigned char *)s;
2669 /* If the decode table is not yet initialized, prepare it. */
2670 if (decode_table[digits[1]] != 1) {
2672 memset(decode_table, 0xff, sizeof(decode_table));
2673 for (i = 0; i < sizeof(digits); i++)
2674 decode_table[digits[i]] = i;
2677 /* Allocate enough space to hold the entire output. */
2678 /* Note that we may not use all of this... */
2679 out = (char *)malloc(len - len / 4 + 1);
2687 /* Collect the next group of (up to) four characters. */
2690 while (group_size < 4 && len > 0) {
2691 /* '=' or '_' padding indicates final group. */
2692 if (*src == '=' || *src == '_') {
2696 /* Skip illegal characters (including line breaks) */
2697 if (*src > 127 || *src < 32
2698 || decode_table[*src] == 0xff) {
2704 v |= decode_table[*src++];
2708 /* Align a short group properly. */
2709 v <<= 6 * (4 - group_size);
2710 /* Unpack the group we just collected. */
2711 switch (group_size) {
2712 case 4: d[2] = v & 0xff;
2714 case 3: d[1] = (v >> 8) & 0xff;
2716 case 2: d[0] = (v >> 16) & 0xff;
2718 case 1: /* this is invalid! */
2721 d += group_size * 3 / 4;
2729 url_decode(const char *in)
2734 out = (char *)malloc(strlen(in) + 1);
2737 for (s = in, d = out; *s != '\0'; ) {
2738 if (s[0] == '%' && s[1] != '\0' && s[2] != '\0') {
2739 /* Try to convert % escape */
2740 int digit1 = tohex(s[1]);
2741 int digit2 = tohex(s[2]);
2742 if (digit1 >= 0 && digit2 >= 0) {
2743 /* Looks good, consume three chars */
2745 /* Convert output */
2746 *d++ = ((digit1 << 4) | digit2);
2749 /* Else fall through and treat '%' as normal char */
2760 if (c >= '0' && c <= '9')
2762 else if (c >= 'A' && c <= 'F')
2763 return (c - 'A' + 10);
2764 else if (c >= 'a' && c <= 'f')
2765 return (c - 'a' + 10);