archive_read_support_format_tar.c revision 315432
1/*-
2 * Copyright (c) 2003-2007 Tim Kientzle
3 * Copyright (c) 2011-2012 Michihiro NAKAJIMA
4 * Copyright (c) 2016 Martin Matuska
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28#include "archive_platform.h"
29__FBSDID("$FreeBSD: stable/11/contrib/libarchive/libarchive/archive_read_support_format_tar.c 315432 2017-03-16 23:07:35Z mm $");
30
31#ifdef HAVE_ERRNO_H
32#include <errno.h>
33#endif
34#include <stddef.h>
35#ifdef HAVE_STDLIB_H
36#include <stdlib.h>
37#endif
38#ifdef HAVE_STRING_H
39#include <string.h>
40#endif
41
42#include "archive.h"
43#include "archive_acl_private.h" /* For ACL parsing routines. */
44#include "archive_entry.h"
45#include "archive_entry_locale.h"
46#include "archive_private.h"
47#include "archive_read_private.h"
48
49#define tar_min(a,b) ((a) < (b) ? (a) : (b))
50
51/*
52 * Layout of POSIX 'ustar' tar header.
53 */
54struct archive_entry_header_ustar {
55	char	name[100];
56	char	mode[8];
57	char	uid[8];
58	char	gid[8];
59	char	size[12];
60	char	mtime[12];
61	char	checksum[8];
62	char	typeflag[1];
63	char	linkname[100];	/* "old format" header ends here */
64	char	magic[6];	/* For POSIX: "ustar\0" */
65	char	version[2];	/* For POSIX: "00" */
66	char	uname[32];
67	char	gname[32];
68	char	rdevmajor[8];
69	char	rdevminor[8];
70	char	prefix[155];
71};
72
73/*
74 * Structure of GNU tar header
75 */
76struct gnu_sparse {
77	char	offset[12];
78	char	numbytes[12];
79};
80
81struct archive_entry_header_gnutar {
82	char	name[100];
83	char	mode[8];
84	char	uid[8];
85	char	gid[8];
86	char	size[12];
87	char	mtime[12];
88	char	checksum[8];
89	char	typeflag[1];
90	char	linkname[100];
91	char	magic[8];  /* "ustar  \0" (note blank/blank/null at end) */
92	char	uname[32];
93	char	gname[32];
94	char	rdevmajor[8];
95	char	rdevminor[8];
96	char	atime[12];
97	char	ctime[12];
98	char	offset[12];
99	char	longnames[4];
100	char	unused[1];
101	struct gnu_sparse sparse[4];
102	char	isextended[1];
103	char	realsize[12];
104	/*
105	 * Old GNU format doesn't use POSIX 'prefix' field; they use
106	 * the 'L' (longname) entry instead.
107	 */
108};
109
110/*
111 * Data specific to this format.
112 */
113struct sparse_block {
114	struct sparse_block	*next;
115	int64_t	offset;
116	int64_t	remaining;
117	int hole;
118};
119
120struct tar {
121	struct archive_string	 acl_text;
122	struct archive_string	 entry_pathname;
123	/* For "GNU.sparse.name" and other similar path extensions. */
124	struct archive_string	 entry_pathname_override;
125	struct archive_string	 entry_linkpath;
126	struct archive_string	 entry_uname;
127	struct archive_string	 entry_gname;
128	struct archive_string	 longlink;
129	struct archive_string	 longname;
130	struct archive_string	 pax_header;
131	struct archive_string	 pax_global;
132	struct archive_string	 line;
133	int			 pax_hdrcharset_binary;
134	int			 header_recursion_depth;
135	int64_t			 entry_bytes_remaining;
136	int64_t			 entry_offset;
137	int64_t			 entry_padding;
138	int64_t 		 entry_bytes_unconsumed;
139	int64_t			 realsize;
140	int			 sparse_allowed;
141	struct sparse_block	*sparse_list;
142	struct sparse_block	*sparse_last;
143	int64_t			 sparse_offset;
144	int64_t			 sparse_numbytes;
145	int			 sparse_gnu_major;
146	int			 sparse_gnu_minor;
147	char			 sparse_gnu_pending;
148
149	struct archive_string	 localname;
150	struct archive_string_conv *opt_sconv;
151	struct archive_string_conv *sconv;
152	struct archive_string_conv *sconv_acl;
153	struct archive_string_conv *sconv_default;
154	int			 init_default_conversion;
155	int			 compat_2x;
156	int			 process_mac_extensions;
157	int			 read_concatenated_archives;
158};
159
160static int	archive_block_is_null(const char *p);
161static char	*base64_decode(const char *, size_t, size_t *);
162static int	gnu_add_sparse_entry(struct archive_read *, struct tar *,
163		    int64_t offset, int64_t remaining);
164
165static void	gnu_clear_sparse_list(struct tar *);
166static int	gnu_sparse_old_read(struct archive_read *, struct tar *,
167		    const struct archive_entry_header_gnutar *header, size_t *);
168static int	gnu_sparse_old_parse(struct archive_read *, struct tar *,
169		    const struct gnu_sparse *sparse, int length);
170static int	gnu_sparse_01_parse(struct archive_read *, struct tar *,
171		    const char *);
172static ssize_t	gnu_sparse_10_read(struct archive_read *, struct tar *,
173			size_t *);
174static int	header_Solaris_ACL(struct archive_read *,  struct tar *,
175		    struct archive_entry *, const void *, size_t *);
176static int	header_common(struct archive_read *,  struct tar *,
177		    struct archive_entry *, const void *);
178static int	header_old_tar(struct archive_read *, struct tar *,
179		    struct archive_entry *, const void *);
180static int	header_pax_extensions(struct archive_read *, struct tar *,
181		    struct archive_entry *, const void *, size_t *);
182static int	header_pax_global(struct archive_read *, struct tar *,
183		    struct archive_entry *, const void *h, size_t *);
184static int	header_longlink(struct archive_read *, struct tar *,
185		    struct archive_entry *, const void *h, size_t *);
186static int	header_longname(struct archive_read *, struct tar *,
187		    struct archive_entry *, const void *h, size_t *);
188static int	read_mac_metadata_blob(struct archive_read *, struct tar *,
189		    struct archive_entry *, const void *h, size_t *);
190static int	header_volume(struct archive_read *, struct tar *,
191		    struct archive_entry *, const void *h, size_t *);
192static int	header_ustar(struct archive_read *, struct tar *,
193		    struct archive_entry *, const void *h);
194static int	header_gnutar(struct archive_read *, struct tar *,
195		    struct archive_entry *, const void *h, size_t *);
196static int	archive_read_format_tar_bid(struct archive_read *, int);
197static int	archive_read_format_tar_options(struct archive_read *,
198		    const char *, const char *);
199static int	archive_read_format_tar_cleanup(struct archive_read *);
200static int	archive_read_format_tar_read_data(struct archive_read *a,
201		    const void **buff, size_t *size, int64_t *offset);
202static int	archive_read_format_tar_skip(struct archive_read *a);
203static int	archive_read_format_tar_read_header(struct archive_read *,
204		    struct archive_entry *);
205static int	checksum(struct archive_read *, const void *);
206static int 	pax_attribute(struct archive_read *, struct tar *,
207		    struct archive_entry *, const char *key, const char *value,
208		    size_t value_length);
209static int	pax_attribute_acl(struct archive_read *, struct tar *,
210		    struct archive_entry *, const char *, int);
211static int	pax_attribute_xattr(struct archive_entry *, const char *,
212		    const char *);
213static int 	pax_header(struct archive_read *, struct tar *,
214		    struct archive_entry *, struct archive_string *);
215static void	pax_time(const char *, int64_t *sec, long *nanos);
216static ssize_t	readline(struct archive_read *, struct tar *, const char **,
217		    ssize_t limit, size_t *);
218static int	read_body_to_string(struct archive_read *, struct tar *,
219		    struct archive_string *, const void *h, size_t *);
220static int	solaris_sparse_parse(struct archive_read *, struct tar *,
221		    struct archive_entry *, const char *);
222static int64_t	tar_atol(const char *, size_t);
223static int64_t	tar_atol10(const char *, size_t);
224static int64_t	tar_atol256(const char *, size_t);
225static int64_t	tar_atol8(const char *, size_t);
226static int	tar_read_header(struct archive_read *, struct tar *,
227		    struct archive_entry *, size_t *);
228static int	tohex(int c);
229static char	*url_decode(const char *);
230static void	tar_flush_unconsumed(struct archive_read *, size_t *);
231
232
233int
234archive_read_support_format_gnutar(struct archive *a)
235{
236	archive_check_magic(a, ARCHIVE_READ_MAGIC,
237	    ARCHIVE_STATE_NEW, "archive_read_support_format_gnutar");
238	return (archive_read_support_format_tar(a));
239}
240
241
242int
243archive_read_support_format_tar(struct archive *_a)
244{
245	struct archive_read *a = (struct archive_read *)_a;
246	struct tar *tar;
247	int r;
248
249	archive_check_magic(_a, ARCHIVE_READ_MAGIC,
250	    ARCHIVE_STATE_NEW, "archive_read_support_format_tar");
251
252	tar = (struct tar *)calloc(1, sizeof(*tar));
253#ifdef HAVE_COPYFILE_H
254	/* Set this by default on Mac OS. */
255	tar->process_mac_extensions = 1;
256#endif
257	if (tar == NULL) {
258		archive_set_error(&a->archive, ENOMEM,
259		    "Can't allocate tar data");
260		return (ARCHIVE_FATAL);
261	}
262
263	r = __archive_read_register_format(a, tar, "tar",
264	    archive_read_format_tar_bid,
265	    archive_read_format_tar_options,
266	    archive_read_format_tar_read_header,
267	    archive_read_format_tar_read_data,
268	    archive_read_format_tar_skip,
269	    NULL,
270	    archive_read_format_tar_cleanup,
271	    NULL,
272	    NULL);
273
274	if (r != ARCHIVE_OK)
275		free(tar);
276	return (ARCHIVE_OK);
277}
278
279static int
280archive_read_format_tar_cleanup(struct archive_read *a)
281{
282	struct tar *tar;
283
284	tar = (struct tar *)(a->format->data);
285	gnu_clear_sparse_list(tar);
286	archive_string_free(&tar->acl_text);
287	archive_string_free(&tar->entry_pathname);
288	archive_string_free(&tar->entry_pathname_override);
289	archive_string_free(&tar->entry_linkpath);
290	archive_string_free(&tar->entry_uname);
291	archive_string_free(&tar->entry_gname);
292	archive_string_free(&tar->line);
293	archive_string_free(&tar->pax_global);
294	archive_string_free(&tar->pax_header);
295	archive_string_free(&tar->longname);
296	archive_string_free(&tar->longlink);
297	archive_string_free(&tar->localname);
298	free(tar);
299	(a->format->data) = NULL;
300	return (ARCHIVE_OK);
301}
302
303/*
304 * Validate number field
305 *
306 * This has to be pretty lenient in order to accommodate the enormous
307 * variety of tar writers in the world:
308 *  = POSIX (IEEE Std 1003.1-1988) ustar requires octal values with leading
309 *    zeros and allows fields to be terminated with space or null characters
310 *  = Many writers use different termination (in particular, libarchive
311 *    omits terminator bytes to squeeze one or two more digits)
312 *  = Many writers pad with space and omit leading zeros
313 *  = GNU tar and star write base-256 values if numbers are too
314 *    big to be represented in octal
315 *
316 *  Examples of specific tar headers that we should support:
317 *  = Perl Archive::Tar terminates uid, gid, devminor and devmajor with two
318 *    null bytes, pads size with spaces and other numeric fields with zeroes
319 *  = plexus-archiver prior to 2.6.3 (before switching to commons-compress)
320 *    may have uid and gid fields filled with spaces without any octal digits
321 *    at all and pads all numeric fields with spaces
322 *
323 * This should tolerate all variants in use.  It will reject a field
324 * where the writer just left garbage after a trailing NUL.
325 */
326static int
327validate_number_field(const char* p_field, size_t i_size)
328{
329	unsigned char marker = (unsigned char)p_field[0];
330	if (marker == 128 || marker == 255 || marker == 0) {
331		/* Base-256 marker, there's nothing we can check. */
332		return 1;
333	} else {
334		/* Must be octal */
335		size_t i = 0;
336		/* Skip any leading spaces */
337		while (i < i_size && p_field[i] == ' ') {
338			++i;
339		}
340		/* Skip octal digits. */
341		while (i < i_size && p_field[i] >= '0' && p_field[i] <= '7') {
342			++i;
343		}
344		/* Any remaining characters must be space or NUL padding. */
345		while (i < i_size) {
346			if (p_field[i] != ' ' && p_field[i] != 0) {
347				return 0;
348			}
349			++i;
350		}
351		return 1;
352	}
353}
354
355static int
356archive_read_format_tar_bid(struct archive_read *a, int best_bid)
357{
358	int bid;
359	const char *h;
360	const struct archive_entry_header_ustar *header;
361
362	(void)best_bid; /* UNUSED */
363
364	bid = 0;
365
366	/* Now let's look at the actual header and see if it matches. */
367	h = __archive_read_ahead(a, 512, NULL);
368	if (h == NULL)
369		return (-1);
370
371	/* If it's an end-of-archive mark, we can handle it. */
372	if (h[0] == 0 && archive_block_is_null(h)) {
373		/*
374		 * Usually, I bid the number of bits verified, but
375		 * in this case, 4096 seems excessive so I picked 10 as
376		 * an arbitrary but reasonable-seeming value.
377		 */
378		return (10);
379	}
380
381	/* If it's not an end-of-archive mark, it must have a valid checksum.*/
382	if (!checksum(a, h))
383		return (0);
384	bid += 48;  /* Checksum is usually 6 octal digits. */
385
386	header = (const struct archive_entry_header_ustar *)h;
387
388	/* Recognize POSIX formats. */
389	if ((memcmp(header->magic, "ustar\0", 6) == 0)
390	    && (memcmp(header->version, "00", 2) == 0))
391		bid += 56;
392
393	/* Recognize GNU tar format. */
394	if ((memcmp(header->magic, "ustar ", 6) == 0)
395	    && (memcmp(header->version, " \0", 2) == 0))
396		bid += 56;
397
398	/* Type flag must be null, digit or A-Z, a-z. */
399	if (header->typeflag[0] != 0 &&
400	    !( header->typeflag[0] >= '0' && header->typeflag[0] <= '9') &&
401	    !( header->typeflag[0] >= 'A' && header->typeflag[0] <= 'Z') &&
402	    !( header->typeflag[0] >= 'a' && header->typeflag[0] <= 'z') )
403		return (0);
404	bid += 2;  /* 6 bits of variation in an 8-bit field leaves 2 bits. */
405
406	/*
407	 * Check format of mode/uid/gid/mtime/size/rdevmajor/rdevminor fields.
408	 */
409	if (bid > 0 && (
410	    validate_number_field(header->mode, sizeof(header->mode)) == 0
411	    || validate_number_field(header->uid, sizeof(header->uid)) == 0
412	    || validate_number_field(header->gid, sizeof(header->gid)) == 0
413	    || validate_number_field(header->mtime, sizeof(header->mtime)) == 0
414	    || validate_number_field(header->size, sizeof(header->size)) == 0
415	    || validate_number_field(header->rdevmajor, sizeof(header->rdevmajor)) == 0
416	    || validate_number_field(header->rdevminor, sizeof(header->rdevminor)) == 0)) {
417		bid = 0;
418	}
419
420	return (bid);
421}
422
423static int
424archive_read_format_tar_options(struct archive_read *a,
425    const char *key, const char *val)
426{
427	struct tar *tar;
428	int ret = ARCHIVE_FAILED;
429
430	tar = (struct tar *)(a->format->data);
431	if (strcmp(key, "compat-2x")  == 0) {
432		/* Handle UTF-8 filenames as libarchive 2.x */
433		tar->compat_2x = (val != NULL && val[0] != 0);
434		tar->init_default_conversion = tar->compat_2x;
435		return (ARCHIVE_OK);
436	} else if (strcmp(key, "hdrcharset")  == 0) {
437		if (val == NULL || val[0] == 0)
438			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
439			    "tar: hdrcharset option needs a character-set name");
440		else {
441			tar->opt_sconv =
442			    archive_string_conversion_from_charset(
443				&a->archive, val, 0);
444			if (tar->opt_sconv != NULL)
445				ret = ARCHIVE_OK;
446			else
447				ret = ARCHIVE_FATAL;
448		}
449		return (ret);
450	} else if (strcmp(key, "mac-ext") == 0) {
451		tar->process_mac_extensions = (val != NULL && val[0] != 0);
452		return (ARCHIVE_OK);
453	} else if (strcmp(key, "read_concatenated_archives") == 0) {
454		tar->read_concatenated_archives = (val != NULL && val[0] != 0);
455		return (ARCHIVE_OK);
456	}
457
458	/* Note: The "warn" return is just to inform the options
459	 * supervisor that we didn't handle it.  It will generate
460	 * a suitable error if no one used this option. */
461	return (ARCHIVE_WARN);
462}
463
464/* utility function- this exists to centralize the logic of tracking
465 * how much unconsumed data we have floating around, and to consume
466 * anything outstanding since we're going to do read_aheads
467 */
468static void
469tar_flush_unconsumed(struct archive_read *a, size_t *unconsumed)
470{
471	if (*unconsumed) {
472/*
473		void *data = (void *)__archive_read_ahead(a, *unconsumed, NULL);
474		 * this block of code is to poison claimed unconsumed space, ensuring
475		 * things break if it is in use still.
476		 * currently it WILL break things, so enable it only for debugging this issue
477		if (data) {
478			memset(data, 0xff, *unconsumed);
479		}
480*/
481		__archive_read_consume(a, *unconsumed);
482		*unconsumed = 0;
483	}
484}
485
486/*
487 * The function invoked by archive_read_next_header().  This
488 * just sets up a few things and then calls the internal
489 * tar_read_header() function below.
490 */
491static int
492archive_read_format_tar_read_header(struct archive_read *a,
493    struct archive_entry *entry)
494{
495	/*
496	 * When converting tar archives to cpio archives, it is
497	 * essential that each distinct file have a distinct inode
498	 * number.  To simplify this, we keep a static count here to
499	 * assign fake dev/inode numbers to each tar entry.  Note that
500	 * pax format archives may overwrite this with something more
501	 * useful.
502	 *
503	 * Ideally, we would track every file read from the archive so
504	 * that we could assign the same dev/ino pair to hardlinks,
505	 * but the memory required to store a complete lookup table is
506	 * probably not worthwhile just to support the relatively
507	 * obscure tar->cpio conversion case.
508	 */
509	static int default_inode;
510	static int default_dev;
511	struct tar *tar;
512	const char *p;
513	const wchar_t *wp;
514	int r;
515	size_t l, unconsumed = 0;
516
517	/* Assign default device/inode values. */
518	archive_entry_set_dev(entry, 1 + default_dev); /* Don't use zero. */
519	archive_entry_set_ino(entry, ++default_inode); /* Don't use zero. */
520	/* Limit generated st_ino number to 16 bits. */
521	if (default_inode >= 0xffff) {
522		++default_dev;
523		default_inode = 0;
524	}
525
526	tar = (struct tar *)(a->format->data);
527	tar->entry_offset = 0;
528	gnu_clear_sparse_list(tar);
529	tar->realsize = -1; /* Mark this as "unset" */
530
531	/* Setup default string conversion. */
532	tar->sconv = tar->opt_sconv;
533	if (tar->sconv == NULL) {
534		if (!tar->init_default_conversion) {
535			tar->sconv_default =
536			    archive_string_default_conversion_for_read(&(a->archive));
537			tar->init_default_conversion = 1;
538		}
539		tar->sconv = tar->sconv_default;
540	}
541
542	r = tar_read_header(a, tar, entry, &unconsumed);
543
544	tar_flush_unconsumed(a, &unconsumed);
545
546	/*
547	 * "non-sparse" files are really just sparse files with
548	 * a single block.
549	 */
550	if (tar->sparse_list == NULL) {
551		if (gnu_add_sparse_entry(a, tar, 0, tar->entry_bytes_remaining)
552		    != ARCHIVE_OK)
553			return (ARCHIVE_FATAL);
554	} else {
555		struct sparse_block *sb;
556
557		for (sb = tar->sparse_list; sb != NULL; sb = sb->next) {
558			if (!sb->hole)
559				archive_entry_sparse_add_entry(entry,
560				    sb->offset, sb->remaining);
561		}
562	}
563
564	if (r == ARCHIVE_OK && archive_entry_filetype(entry) == AE_IFREG) {
565		/*
566		 * "Regular" entry with trailing '/' is really
567		 * directory: This is needed for certain old tar
568		 * variants and even for some broken newer ones.
569		 */
570		if ((wp = archive_entry_pathname_w(entry)) != NULL) {
571			l = wcslen(wp);
572			if (l > 0 && wp[l - 1] == L'/') {
573				archive_entry_set_filetype(entry, AE_IFDIR);
574			}
575		} else if ((p = archive_entry_pathname(entry)) != NULL) {
576			l = strlen(p);
577			if (l > 0 && p[l - 1] == '/') {
578				archive_entry_set_filetype(entry, AE_IFDIR);
579			}
580		}
581	}
582	return (r);
583}
584
585static int
586archive_read_format_tar_read_data(struct archive_read *a,
587    const void **buff, size_t *size, int64_t *offset)
588{
589	ssize_t bytes_read;
590	struct tar *tar;
591	struct sparse_block *p;
592
593	tar = (struct tar *)(a->format->data);
594
595	for (;;) {
596		/* Remove exhausted entries from sparse list. */
597		while (tar->sparse_list != NULL &&
598		    tar->sparse_list->remaining == 0) {
599			p = tar->sparse_list;
600			tar->sparse_list = p->next;
601			free(p);
602		}
603
604		if (tar->entry_bytes_unconsumed) {
605			__archive_read_consume(a, tar->entry_bytes_unconsumed);
606			tar->entry_bytes_unconsumed = 0;
607		}
608
609		/* If we're at end of file, return EOF. */
610		if (tar->sparse_list == NULL ||
611		    tar->entry_bytes_remaining == 0) {
612			if (__archive_read_consume(a, tar->entry_padding) < 0)
613				return (ARCHIVE_FATAL);
614			tar->entry_padding = 0;
615			*buff = NULL;
616			*size = 0;
617			*offset = tar->realsize;
618			return (ARCHIVE_EOF);
619		}
620
621		*buff = __archive_read_ahead(a, 1, &bytes_read);
622		if (bytes_read < 0)
623			return (ARCHIVE_FATAL);
624		if (*buff == NULL) {
625			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
626			    "Truncated tar archive");
627			return (ARCHIVE_FATAL);
628		}
629		if (bytes_read > tar->entry_bytes_remaining)
630			bytes_read = (ssize_t)tar->entry_bytes_remaining;
631		/* Don't read more than is available in the
632		 * current sparse block. */
633		if (tar->sparse_list->remaining < bytes_read)
634			bytes_read = (ssize_t)tar->sparse_list->remaining;
635		*size = bytes_read;
636		*offset = tar->sparse_list->offset;
637		tar->sparse_list->remaining -= bytes_read;
638		tar->sparse_list->offset += bytes_read;
639		tar->entry_bytes_remaining -= bytes_read;
640		tar->entry_bytes_unconsumed = bytes_read;
641
642		if (!tar->sparse_list->hole)
643			return (ARCHIVE_OK);
644		/* Current is hole data and skip this. */
645	}
646}
647
648static int
649archive_read_format_tar_skip(struct archive_read *a)
650{
651	int64_t bytes_skipped;
652	int64_t request;
653	struct sparse_block *p;
654	struct tar* tar;
655
656	tar = (struct tar *)(a->format->data);
657
658	/* Do not consume the hole of a sparse file. */
659	request = 0;
660	for (p = tar->sparse_list; p != NULL; p = p->next) {
661		if (!p->hole) {
662			if (p->remaining >= INT64_MAX - request) {
663				return ARCHIVE_FATAL;
664			}
665			request += p->remaining;
666		}
667	}
668	if (request > tar->entry_bytes_remaining)
669		request = tar->entry_bytes_remaining;
670	request += tar->entry_padding + tar->entry_bytes_unconsumed;
671
672	bytes_skipped = __archive_read_consume(a, request);
673	if (bytes_skipped < 0)
674		return (ARCHIVE_FATAL);
675
676	tar->entry_bytes_remaining = 0;
677	tar->entry_bytes_unconsumed = 0;
678	tar->entry_padding = 0;
679
680	/* Free the sparse list. */
681	gnu_clear_sparse_list(tar);
682
683	return (ARCHIVE_OK);
684}
685
686/*
687 * This function recursively interprets all of the headers associated
688 * with a single entry.
689 */
690static int
691tar_read_header(struct archive_read *a, struct tar *tar,
692    struct archive_entry *entry, size_t *unconsumed)
693{
694	ssize_t bytes;
695	int err;
696	const char *h;
697	const struct archive_entry_header_ustar *header;
698	const struct archive_entry_header_gnutar *gnuheader;
699
700	/* Loop until we find a workable header record. */
701	for (;;) {
702		tar_flush_unconsumed(a, unconsumed);
703
704		/* Read 512-byte header record */
705		h = __archive_read_ahead(a, 512, &bytes);
706		if (bytes < 0)
707			return ((int)bytes);
708		if (bytes == 0) { /* EOF at a block boundary. */
709			/* Some writers do omit the block of nulls. <sigh> */
710			return (ARCHIVE_EOF);
711		}
712		if (bytes < 512) {  /* Short block at EOF; this is bad. */
713			archive_set_error(&a->archive,
714			    ARCHIVE_ERRNO_FILE_FORMAT,
715			    "Truncated tar archive");
716			return (ARCHIVE_FATAL);
717		}
718		*unconsumed = 512;
719
720		/* Header is workable if it's not an end-of-archive mark. */
721		if (h[0] != 0 || !archive_block_is_null(h))
722			break;
723
724		/* Ensure format is set for archives with only null blocks. */
725		if (a->archive.archive_format_name == NULL) {
726			a->archive.archive_format = ARCHIVE_FORMAT_TAR;
727			a->archive.archive_format_name = "tar";
728		}
729
730		if (!tar->read_concatenated_archives) {
731			/* Try to consume a second all-null record, as well. */
732			tar_flush_unconsumed(a, unconsumed);
733			h = __archive_read_ahead(a, 512, NULL);
734			if (h != NULL && h[0] == 0 && archive_block_is_null(h))
735				__archive_read_consume(a, 512);
736			archive_clear_error(&a->archive);
737			return (ARCHIVE_EOF);
738		}
739
740		/*
741		 * We're reading concatenated archives, ignore this block and
742		 * loop to get the next.
743		 */
744	}
745
746	/*
747	 * Note: If the checksum fails and we return ARCHIVE_RETRY,
748	 * then the client is likely to just retry.  This is a very
749	 * crude way to search for the next valid header!
750	 *
751	 * TODO: Improve this by implementing a real header scan.
752	 */
753	if (!checksum(a, h)) {
754		tar_flush_unconsumed(a, unconsumed);
755		archive_set_error(&a->archive, EINVAL, "Damaged tar archive");
756		return (ARCHIVE_RETRY); /* Retryable: Invalid header */
757	}
758
759	if (++tar->header_recursion_depth > 32) {
760		tar_flush_unconsumed(a, unconsumed);
761		archive_set_error(&a->archive, EINVAL, "Too many special headers");
762		return (ARCHIVE_WARN);
763	}
764
765	/* Determine the format variant. */
766	header = (const struct archive_entry_header_ustar *)h;
767
768	switch(header->typeflag[0]) {
769	case 'A': /* Solaris tar ACL */
770		a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
771		a->archive.archive_format_name = "Solaris tar";
772		err = header_Solaris_ACL(a, tar, entry, h, unconsumed);
773		break;
774	case 'g': /* POSIX-standard 'g' header. */
775		a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
776		a->archive.archive_format_name = "POSIX pax interchange format";
777		err = header_pax_global(a, tar, entry, h, unconsumed);
778		if (err == ARCHIVE_EOF)
779			return (err);
780		break;
781	case 'K': /* Long link name (GNU tar, others) */
782		err = header_longlink(a, tar, entry, h, unconsumed);
783		break;
784	case 'L': /* Long filename (GNU tar, others) */
785		err = header_longname(a, tar, entry, h, unconsumed);
786		break;
787	case 'V': /* GNU volume header */
788		err = header_volume(a, tar, entry, h, unconsumed);
789		break;
790	case 'X': /* Used by SUN tar; same as 'x'. */
791		a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
792		a->archive.archive_format_name =
793		    "POSIX pax interchange format (Sun variant)";
794		err = header_pax_extensions(a, tar, entry, h, unconsumed);
795		break;
796	case 'x': /* POSIX-standard 'x' header. */
797		a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
798		a->archive.archive_format_name = "POSIX pax interchange format";
799		err = header_pax_extensions(a, tar, entry, h, unconsumed);
800		break;
801	default:
802		gnuheader = (const struct archive_entry_header_gnutar *)h;
803		if (memcmp(gnuheader->magic, "ustar  \0", 8) == 0) {
804			a->archive.archive_format = ARCHIVE_FORMAT_TAR_GNUTAR;
805			a->archive.archive_format_name = "GNU tar format";
806			err = header_gnutar(a, tar, entry, h, unconsumed);
807		} else if (memcmp(header->magic, "ustar", 5) == 0) {
808			if (a->archive.archive_format != ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE) {
809				a->archive.archive_format = ARCHIVE_FORMAT_TAR_USTAR;
810				a->archive.archive_format_name = "POSIX ustar format";
811			}
812			err = header_ustar(a, tar, entry, h);
813		} else {
814			a->archive.archive_format = ARCHIVE_FORMAT_TAR;
815			a->archive.archive_format_name = "tar (non-POSIX)";
816			err = header_old_tar(a, tar, entry, h);
817		}
818	}
819	if (err == ARCHIVE_FATAL)
820		return (err);
821
822	tar_flush_unconsumed(a, unconsumed);
823
824	h = NULL;
825	header = NULL;
826
827	--tar->header_recursion_depth;
828	/* Yuck.  Apple's design here ends up storing long pathname
829	 * extensions for both the AppleDouble extension entry and the
830	 * regular entry.
831	 */
832	if ((err == ARCHIVE_WARN || err == ARCHIVE_OK) &&
833	    tar->header_recursion_depth == 0 &&
834	    tar->process_mac_extensions) {
835		int err2 = read_mac_metadata_blob(a, tar, entry, h, unconsumed);
836		if (err2 < err)
837			err = err2;
838	}
839
840	/* We return warnings or success as-is.  Anything else is fatal. */
841	if (err == ARCHIVE_WARN || err == ARCHIVE_OK) {
842		if (tar->sparse_gnu_pending) {
843			if (tar->sparse_gnu_major == 1 &&
844			    tar->sparse_gnu_minor == 0) {
845				ssize_t bytes_read;
846
847				tar->sparse_gnu_pending = 0;
848				/* Read initial sparse map. */
849				bytes_read = gnu_sparse_10_read(a, tar, unconsumed);
850				if (bytes_read < 0)
851					return ((int)bytes_read);
852				tar->entry_bytes_remaining -= bytes_read;
853			} else {
854				archive_set_error(&a->archive,
855				    ARCHIVE_ERRNO_MISC,
856				    "Unrecognized GNU sparse file format");
857				return (ARCHIVE_WARN);
858			}
859			tar->sparse_gnu_pending = 0;
860		}
861		return (err);
862	}
863	if (err == ARCHIVE_EOF)
864		/* EOF when recursively reading a header is bad. */
865		archive_set_error(&a->archive, EINVAL, "Damaged tar archive");
866	return (ARCHIVE_FATAL);
867}
868
869/*
870 * Return true if block checksum is correct.
871 */
872static int
873checksum(struct archive_read *a, const void *h)
874{
875	const unsigned char *bytes;
876	const struct archive_entry_header_ustar	*header;
877	int check, sum;
878	size_t i;
879
880	(void)a; /* UNUSED */
881	bytes = (const unsigned char *)h;
882	header = (const struct archive_entry_header_ustar *)h;
883
884	/* Checksum field must hold an octal number */
885	for (i = 0; i < sizeof(header->checksum); ++i) {
886		char c = header->checksum[i];
887		if (c != ' ' && c != '\0' && (c < '0' || c > '7'))
888			return 0;
889	}
890
891	/*
892	 * Test the checksum.  Note that POSIX specifies _unsigned_
893	 * bytes for this calculation.
894	 */
895	sum = (int)tar_atol(header->checksum, sizeof(header->checksum));
896	check = 0;
897	for (i = 0; i < 148; i++)
898		check += (unsigned char)bytes[i];
899	for (; i < 156; i++)
900		check += 32;
901	for (; i < 512; i++)
902		check += (unsigned char)bytes[i];
903	if (sum == check)
904		return (1);
905
906	/*
907	 * Repeat test with _signed_ bytes, just in case this archive
908	 * was created by an old BSD, Solaris, or HP-UX tar with a
909	 * broken checksum calculation.
910	 */
911	check = 0;
912	for (i = 0; i < 148; i++)
913		check += (signed char)bytes[i];
914	for (; i < 156; i++)
915		check += 32;
916	for (; i < 512; i++)
917		check += (signed char)bytes[i];
918	if (sum == check)
919		return (1);
920
921	return (0);
922}
923
924/*
925 * Return true if this block contains only nulls.
926 */
927static int
928archive_block_is_null(const char *p)
929{
930	unsigned i;
931
932	for (i = 0; i < 512; i++)
933		if (*p++)
934			return (0);
935	return (1);
936}
937
938/*
939 * Interpret 'A' Solaris ACL header
940 */
941static int
942header_Solaris_ACL(struct archive_read *a, struct tar *tar,
943    struct archive_entry *entry, const void *h, size_t *unconsumed)
944{
945	const struct archive_entry_header_ustar *header;
946	size_t size;
947	int err, acl_type;
948	int64_t type;
949	char *acl, *p;
950
951	/*
952	 * read_body_to_string adds a NUL terminator, but we need a little
953	 * more to make sure that we don't overrun acl_text later.
954	 */
955	header = (const struct archive_entry_header_ustar *)h;
956	size = (size_t)tar_atol(header->size, sizeof(header->size));
957	err = read_body_to_string(a, tar, &(tar->acl_text), h, unconsumed);
958	if (err != ARCHIVE_OK)
959		return (err);
960
961	/* Recursively read next header */
962	err = tar_read_header(a, tar, entry, unconsumed);
963	if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
964		return (err);
965
966	/* TODO: Examine the first characters to see if this
967	 * is an AIX ACL descriptor.  We'll likely never support
968	 * them, but it would be polite to recognize and warn when
969	 * we do see them. */
970
971	/* Leading octal number indicates ACL type and number of entries. */
972	p = acl = tar->acl_text.s;
973	type = 0;
974	while (*p != '\0' && p < acl + size) {
975		if (*p < '0' || *p > '7') {
976			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
977			    "Malformed Solaris ACL attribute (invalid digit)");
978			return(ARCHIVE_WARN);
979		}
980		type <<= 3;
981		type += *p - '0';
982		if (type > 077777777) {
983			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
984			    "Malformed Solaris ACL attribute (count too large)");
985			return (ARCHIVE_WARN);
986		}
987		p++;
988	}
989	switch ((int)type & ~0777777) {
990	case 01000000:
991		/* POSIX.1e ACL */
992		acl_type = ARCHIVE_ENTRY_ACL_TYPE_ACCESS;
993		break;
994	case 03000000:
995		/* NFSv4 ACL */
996		acl_type = ARCHIVE_ENTRY_ACL_TYPE_NFS4;
997		break;
998	default:
999		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1000		    "Malformed Solaris ACL attribute (unsupported type %o)",
1001		    (int)type);
1002		return (ARCHIVE_WARN);
1003	}
1004	p++;
1005
1006	if (p >= acl + size) {
1007		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1008		    "Malformed Solaris ACL attribute (body overflow)");
1009		return(ARCHIVE_WARN);
1010	}
1011
1012	/* ACL text is null-terminated; find the end. */
1013	size -= (p - acl);
1014	acl = p;
1015
1016	while (*p != '\0' && p < acl + size)
1017		p++;
1018
1019	if (tar->sconv_acl == NULL) {
1020		tar->sconv_acl = archive_string_conversion_from_charset(
1021		    &(a->archive), "UTF-8", 1);
1022		if (tar->sconv_acl == NULL)
1023			return (ARCHIVE_FATAL);
1024	}
1025	archive_strncpy(&(tar->localname), acl, p - acl);
1026	err = archive_acl_from_text_l(archive_entry_acl(entry),
1027	    tar->localname.s, acl_type, tar->sconv_acl);
1028	if (err != ARCHIVE_OK) {
1029		if (errno == ENOMEM) {
1030			archive_set_error(&a->archive, ENOMEM,
1031			    "Can't allocate memory for ACL");
1032		} else
1033			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1034			    "Malformed Solaris ACL attribute (unparsable)");
1035	}
1036	return (err);
1037}
1038
1039/*
1040 * Interpret 'K' long linkname header.
1041 */
1042static int
1043header_longlink(struct archive_read *a, struct tar *tar,
1044    struct archive_entry *entry, const void *h, size_t *unconsumed)
1045{
1046	int err;
1047
1048	err = read_body_to_string(a, tar, &(tar->longlink), h, unconsumed);
1049	if (err != ARCHIVE_OK)
1050		return (err);
1051	err = tar_read_header(a, tar, entry, unconsumed);
1052	if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
1053		return (err);
1054	/* Set symlink if symlink already set, else hardlink. */
1055	archive_entry_copy_link(entry, tar->longlink.s);
1056	return (ARCHIVE_OK);
1057}
1058
1059static int
1060set_conversion_failed_error(struct archive_read *a,
1061    struct archive_string_conv *sconv, const char *name)
1062{
1063	if (errno == ENOMEM) {
1064		archive_set_error(&a->archive, ENOMEM,
1065		    "Can't allocate memory for %s", name);
1066		return (ARCHIVE_FATAL);
1067	}
1068	archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1069	    "%s can't be converted from %s to current locale.",
1070	    name, archive_string_conversion_charset_name(sconv));
1071	return (ARCHIVE_WARN);
1072}
1073
1074/*
1075 * Interpret 'L' long filename header.
1076 */
1077static int
1078header_longname(struct archive_read *a, struct tar *tar,
1079    struct archive_entry *entry, const void *h, size_t *unconsumed)
1080{
1081	int err;
1082
1083	err = read_body_to_string(a, tar, &(tar->longname), h, unconsumed);
1084	if (err != ARCHIVE_OK)
1085		return (err);
1086	/* Read and parse "real" header, then override name. */
1087	err = tar_read_header(a, tar, entry, unconsumed);
1088	if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
1089		return (err);
1090	if (archive_entry_copy_pathname_l(entry, tar->longname.s,
1091	    archive_strlen(&(tar->longname)), tar->sconv) != 0)
1092		err = set_conversion_failed_error(a, tar->sconv, "Pathname");
1093	return (err);
1094}
1095
1096
1097/*
1098 * Interpret 'V' GNU tar volume header.
1099 */
1100static int
1101header_volume(struct archive_read *a, struct tar *tar,
1102    struct archive_entry *entry, const void *h, size_t *unconsumed)
1103{
1104	(void)h;
1105
1106	/* Just skip this and read the next header. */
1107	return (tar_read_header(a, tar, entry, unconsumed));
1108}
1109
1110/*
1111 * Read body of an archive entry into an archive_string object.
1112 */
1113static int
1114read_body_to_string(struct archive_read *a, struct tar *tar,
1115    struct archive_string *as, const void *h, size_t *unconsumed)
1116{
1117	int64_t size;
1118	const struct archive_entry_header_ustar *header;
1119	const void *src;
1120
1121	(void)tar; /* UNUSED */
1122	header = (const struct archive_entry_header_ustar *)h;
1123	size  = tar_atol(header->size, sizeof(header->size));
1124	if ((size > 1048576) || (size < 0)) {
1125		archive_set_error(&a->archive, EINVAL,
1126		    "Special header too large");
1127		return (ARCHIVE_FATAL);
1128	}
1129
1130	/* Fail if we can't make our buffer big enough. */
1131	if (archive_string_ensure(as, (size_t)size+1) == NULL) {
1132		archive_set_error(&a->archive, ENOMEM,
1133		    "No memory");
1134		return (ARCHIVE_FATAL);
1135	}
1136
1137	tar_flush_unconsumed(a, unconsumed);
1138
1139	/* Read the body into the string. */
1140	*unconsumed = (size_t)((size + 511) & ~ 511);
1141	src = __archive_read_ahead(a, *unconsumed, NULL);
1142	if (src == NULL) {
1143		*unconsumed = 0;
1144		return (ARCHIVE_FATAL);
1145	}
1146	memcpy(as->s, src, (size_t)size);
1147	as->s[size] = '\0';
1148	as->length = (size_t)size;
1149	return (ARCHIVE_OK);
1150}
1151
1152/*
1153 * Parse out common header elements.
1154 *
1155 * This would be the same as header_old_tar, except that the
1156 * filename is handled slightly differently for old and POSIX
1157 * entries  (POSIX entries support a 'prefix').  This factoring
1158 * allows header_old_tar and header_ustar
1159 * to handle filenames differently, while still putting most of the
1160 * common parsing into one place.
1161 */
1162static int
1163header_common(struct archive_read *a, struct tar *tar,
1164    struct archive_entry *entry, const void *h)
1165{
1166	const struct archive_entry_header_ustar	*header;
1167	char	tartype;
1168	int     err = ARCHIVE_OK;
1169
1170	header = (const struct archive_entry_header_ustar *)h;
1171	if (header->linkname[0])
1172		archive_strncpy(&(tar->entry_linkpath),
1173		    header->linkname, sizeof(header->linkname));
1174	else
1175		archive_string_empty(&(tar->entry_linkpath));
1176
1177	/* Parse out the numeric fields (all are octal) */
1178	archive_entry_set_mode(entry,
1179		(mode_t)tar_atol(header->mode, sizeof(header->mode)));
1180	archive_entry_set_uid(entry, tar_atol(header->uid, sizeof(header->uid)));
1181	archive_entry_set_gid(entry, tar_atol(header->gid, sizeof(header->gid)));
1182	tar->entry_bytes_remaining = tar_atol(header->size, sizeof(header->size));
1183	if (tar->entry_bytes_remaining < 0) {
1184		tar->entry_bytes_remaining = 0;
1185		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1186		    "Tar entry has negative size");
1187		return (ARCHIVE_FATAL);
1188	}
1189	if (tar->entry_bytes_remaining == INT64_MAX) {
1190		/* Note: tar_atol returns INT64_MAX on overflow */
1191		tar->entry_bytes_remaining = 0;
1192		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1193		    "Tar entry size overflow");
1194		return (ARCHIVE_FATAL);
1195	}
1196	tar->realsize = tar->entry_bytes_remaining;
1197	archive_entry_set_size(entry, tar->entry_bytes_remaining);
1198	archive_entry_set_mtime(entry, tar_atol(header->mtime, sizeof(header->mtime)), 0);
1199
1200	/* Handle the tar type flag appropriately. */
1201	tartype = header->typeflag[0];
1202
1203	switch (tartype) {
1204	case '1': /* Hard link */
1205		if (archive_entry_copy_hardlink_l(entry, tar->entry_linkpath.s,
1206		    archive_strlen(&(tar->entry_linkpath)), tar->sconv) != 0) {
1207			err = set_conversion_failed_error(a, tar->sconv,
1208			    "Linkname");
1209			if (err == ARCHIVE_FATAL)
1210				return (err);
1211		}
1212		/*
1213		 * The following may seem odd, but: Technically, tar
1214		 * does not store the file type for a "hard link"
1215		 * entry, only the fact that it is a hard link.  So, I
1216		 * leave the type zero normally.  But, pax interchange
1217		 * format allows hard links to have data, which
1218		 * implies that the underlying entry is a regular
1219		 * file.
1220		 */
1221		if (archive_entry_size(entry) > 0)
1222			archive_entry_set_filetype(entry, AE_IFREG);
1223
1224		/*
1225		 * A tricky point: Traditionally, tar readers have
1226		 * ignored the size field when reading hardlink
1227		 * entries, and some writers put non-zero sizes even
1228		 * though the body is empty.  POSIX blessed this
1229		 * convention in the 1988 standard, but broke with
1230		 * this tradition in 2001 by permitting hardlink
1231		 * entries to store valid bodies in pax interchange
1232		 * format, but not in ustar format.  Since there is no
1233		 * hard and fast way to distinguish pax interchange
1234		 * from earlier archives (the 'x' and 'g' entries are
1235		 * optional, after all), we need a heuristic.
1236		 */
1237		if (archive_entry_size(entry) == 0) {
1238			/* If the size is already zero, we're done. */
1239		}  else if (a->archive.archive_format
1240		    == ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE) {
1241			/* Definitely pax extended; must obey hardlink size. */
1242		} else if (a->archive.archive_format == ARCHIVE_FORMAT_TAR
1243		    || a->archive.archive_format == ARCHIVE_FORMAT_TAR_GNUTAR)
1244		{
1245			/* Old-style or GNU tar: we must ignore the size. */
1246			archive_entry_set_size(entry, 0);
1247			tar->entry_bytes_remaining = 0;
1248		} else if (archive_read_format_tar_bid(a, 50) > 50) {
1249			/*
1250			 * We don't know if it's pax: If the bid
1251			 * function sees a valid ustar header
1252			 * immediately following, then let's ignore
1253			 * the hardlink size.
1254			 */
1255			archive_entry_set_size(entry, 0);
1256			tar->entry_bytes_remaining = 0;
1257		}
1258		/*
1259		 * TODO: There are still two cases I'd like to handle:
1260		 *   = a ustar non-pax archive with a hardlink entry at
1261		 *     end-of-archive.  (Look for block of nulls following?)
1262		 *   = a pax archive that has not seen any pax headers
1263		 *     and has an entry which is a hardlink entry storing
1264		 *     a body containing an uncompressed tar archive.
1265		 * The first is worth addressing; I don't see any reliable
1266		 * way to deal with the second possibility.
1267		 */
1268		break;
1269	case '2': /* Symlink */
1270		archive_entry_set_filetype(entry, AE_IFLNK);
1271		archive_entry_set_size(entry, 0);
1272		tar->entry_bytes_remaining = 0;
1273		if (archive_entry_copy_symlink_l(entry, tar->entry_linkpath.s,
1274		    archive_strlen(&(tar->entry_linkpath)), tar->sconv) != 0) {
1275			err = set_conversion_failed_error(a, tar->sconv,
1276			    "Linkname");
1277			if (err == ARCHIVE_FATAL)
1278				return (err);
1279		}
1280		break;
1281	case '3': /* Character device */
1282		archive_entry_set_filetype(entry, AE_IFCHR);
1283		archive_entry_set_size(entry, 0);
1284		tar->entry_bytes_remaining = 0;
1285		break;
1286	case '4': /* Block device */
1287		archive_entry_set_filetype(entry, AE_IFBLK);
1288		archive_entry_set_size(entry, 0);
1289		tar->entry_bytes_remaining = 0;
1290		break;
1291	case '5': /* Dir */
1292		archive_entry_set_filetype(entry, AE_IFDIR);
1293		archive_entry_set_size(entry, 0);
1294		tar->entry_bytes_remaining = 0;
1295		break;
1296	case '6': /* FIFO device */
1297		archive_entry_set_filetype(entry, AE_IFIFO);
1298		archive_entry_set_size(entry, 0);
1299		tar->entry_bytes_remaining = 0;
1300		break;
1301	case 'D': /* GNU incremental directory type */
1302		/*
1303		 * No special handling is actually required here.
1304		 * It might be nice someday to preprocess the file list and
1305		 * provide it to the client, though.
1306		 */
1307		archive_entry_set_filetype(entry, AE_IFDIR);
1308		break;
1309	case 'M': /* GNU "Multi-volume" (remainder of file from last archive)*/
1310		/*
1311		 * As far as I can tell, this is just like a regular file
1312		 * entry, except that the contents should be _appended_ to
1313		 * the indicated file at the indicated offset.  This may
1314		 * require some API work to fully support.
1315		 */
1316		break;
1317	case 'N': /* Old GNU "long filename" entry. */
1318		/* The body of this entry is a script for renaming
1319		 * previously-extracted entries.  Ugh.  It will never
1320		 * be supported by libarchive. */
1321		archive_entry_set_filetype(entry, AE_IFREG);
1322		break;
1323	case 'S': /* GNU sparse files */
1324		/*
1325		 * Sparse files are really just regular files with
1326		 * sparse information in the extended area.
1327		 */
1328		/* FALLTHROUGH */
1329	case '0':
1330		/*
1331		 * Enable sparse file "read" support only for regular
1332		 * files and explicit GNU sparse files.  However, we
1333		 * don't allow non-standard file types to be sparse.
1334		 */
1335		tar->sparse_allowed = 1;
1336		/* FALLTHROUGH */
1337	default: /* Regular file  and non-standard types */
1338		/*
1339		 * Per POSIX: non-recognized types should always be
1340		 * treated as regular files.
1341		 */
1342		archive_entry_set_filetype(entry, AE_IFREG);
1343		break;
1344	}
1345	return (err);
1346}
1347
1348/*
1349 * Parse out header elements for "old-style" tar archives.
1350 */
1351static int
1352header_old_tar(struct archive_read *a, struct tar *tar,
1353    struct archive_entry *entry, const void *h)
1354{
1355	const struct archive_entry_header_ustar	*header;
1356	int err = ARCHIVE_OK, err2;
1357
1358	/* Copy filename over (to ensure null termination). */
1359	header = (const struct archive_entry_header_ustar *)h;
1360	if (archive_entry_copy_pathname_l(entry,
1361	    header->name, sizeof(header->name), tar->sconv) != 0) {
1362		err = set_conversion_failed_error(a, tar->sconv, "Pathname");
1363		if (err == ARCHIVE_FATAL)
1364			return (err);
1365	}
1366
1367	/* Grab rest of common fields */
1368	err2 = header_common(a, tar, entry, h);
1369	if (err > err2)
1370		err = err2;
1371
1372	tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1373	return (err);
1374}
1375
1376/*
1377 * Read a Mac AppleDouble-encoded blob of file metadata,
1378 * if there is one.
1379 */
1380static int
1381read_mac_metadata_blob(struct archive_read *a, struct tar *tar,
1382    struct archive_entry *entry, const void *h, size_t *unconsumed)
1383{
1384	int64_t size;
1385	const void *data;
1386	const char *p, *name;
1387	const wchar_t *wp, *wname;
1388
1389	(void)h; /* UNUSED */
1390
1391	wname = wp = archive_entry_pathname_w(entry);
1392	if (wp != NULL) {
1393		/* Find the last path element. */
1394		for (; *wp != L'\0'; ++wp) {
1395			if (wp[0] == '/' && wp[1] != L'\0')
1396				wname = wp + 1;
1397		}
1398		/*
1399		 * If last path element starts with "._", then
1400		 * this is a Mac extension.
1401		 */
1402		if (wname[0] != L'.' || wname[1] != L'_' || wname[2] == L'\0')
1403			return ARCHIVE_OK;
1404	} else {
1405		/* Find the last path element. */
1406		name = p = archive_entry_pathname(entry);
1407		if (p == NULL)
1408			return (ARCHIVE_FAILED);
1409		for (; *p != '\0'; ++p) {
1410			if (p[0] == '/' && p[1] != '\0')
1411				name = p + 1;
1412		}
1413		/*
1414		 * If last path element starts with "._", then
1415		 * this is a Mac extension.
1416		 */
1417		if (name[0] != '.' || name[1] != '_' || name[2] == '\0')
1418			return ARCHIVE_OK;
1419	}
1420
1421 	/* Read the body as a Mac OS metadata blob. */
1422	size = archive_entry_size(entry);
1423
1424	/*
1425	 * TODO: Look beyond the body here to peek at the next header.
1426	 * If it's a regular header (not an extension header)
1427	 * that has the wrong name, just return the current
1428	 * entry as-is, without consuming the body here.
1429	 * That would reduce the risk of us mis-identifying
1430	 * an ordinary file that just happened to have
1431	 * a name starting with "._".
1432	 *
1433	 * Q: Is the above idea really possible?  Even
1434	 * when there are GNU or pax extension entries?
1435	 */
1436	data = __archive_read_ahead(a, (size_t)size, NULL);
1437	if (data == NULL) {
1438		*unconsumed = 0;
1439		return (ARCHIVE_FATAL);
1440	}
1441	archive_entry_copy_mac_metadata(entry, data, (size_t)size);
1442	*unconsumed = (size_t)((size + 511) & ~ 511);
1443	tar_flush_unconsumed(a, unconsumed);
1444	return (tar_read_header(a, tar, entry, unconsumed));
1445}
1446
1447/*
1448 * Parse a file header for a pax extended archive entry.
1449 */
1450static int
1451header_pax_global(struct archive_read *a, struct tar *tar,
1452    struct archive_entry *entry, const void *h, size_t *unconsumed)
1453{
1454	int err;
1455
1456	err = read_body_to_string(a, tar, &(tar->pax_global), h, unconsumed);
1457	if (err != ARCHIVE_OK)
1458		return (err);
1459	err = tar_read_header(a, tar, entry, unconsumed);
1460	return (err);
1461}
1462
1463static int
1464header_pax_extensions(struct archive_read *a, struct tar *tar,
1465    struct archive_entry *entry, const void *h, size_t *unconsumed)
1466{
1467	int err, err2;
1468
1469	err = read_body_to_string(a, tar, &(tar->pax_header), h, unconsumed);
1470	if (err != ARCHIVE_OK)
1471		return (err);
1472
1473	/* Parse the next header. */
1474	err = tar_read_header(a, tar, entry, unconsumed);
1475	if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
1476		return (err);
1477
1478	/*
1479	 * TODO: Parse global/default options into 'entry' struct here
1480	 * before handling file-specific options.
1481	 *
1482	 * This design (parse standard header, then overwrite with pax
1483	 * extended attribute data) usually works well, but isn't ideal;
1484	 * it would be better to parse the pax extended attributes first
1485	 * and then skip any fields in the standard header that were
1486	 * defined in the pax header.
1487	 */
1488	err2 = pax_header(a, tar, entry, &tar->pax_header);
1489	err =  err_combine(err, err2);
1490	tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1491	return (err);
1492}
1493
1494
1495/*
1496 * Parse a file header for a Posix "ustar" archive entry.  This also
1497 * handles "pax" or "extended ustar" entries.
1498 */
1499static int
1500header_ustar(struct archive_read *a, struct tar *tar,
1501    struct archive_entry *entry, const void *h)
1502{
1503	const struct archive_entry_header_ustar	*header;
1504	struct archive_string *as;
1505	int err = ARCHIVE_OK, r;
1506
1507	header = (const struct archive_entry_header_ustar *)h;
1508
1509	/* Copy name into an internal buffer to ensure null-termination. */
1510	as = &(tar->entry_pathname);
1511	if (header->prefix[0]) {
1512		archive_strncpy(as, header->prefix, sizeof(header->prefix));
1513		if (as->s[archive_strlen(as) - 1] != '/')
1514			archive_strappend_char(as, '/');
1515		archive_strncat(as, header->name, sizeof(header->name));
1516	} else {
1517		archive_strncpy(as, header->name, sizeof(header->name));
1518	}
1519	if (archive_entry_copy_pathname_l(entry, as->s, archive_strlen(as),
1520	    tar->sconv) != 0) {
1521		err = set_conversion_failed_error(a, tar->sconv, "Pathname");
1522		if (err == ARCHIVE_FATAL)
1523			return (err);
1524	}
1525
1526	/* Handle rest of common fields. */
1527	r = header_common(a, tar, entry, h);
1528	if (r == ARCHIVE_FATAL)
1529		return (r);
1530	if (r < err)
1531		err = r;
1532
1533	/* Handle POSIX ustar fields. */
1534	if (archive_entry_copy_uname_l(entry,
1535	    header->uname, sizeof(header->uname), tar->sconv) != 0) {
1536		err = set_conversion_failed_error(a, tar->sconv, "Uname");
1537		if (err == ARCHIVE_FATAL)
1538			return (err);
1539	}
1540
1541	if (archive_entry_copy_gname_l(entry,
1542	    header->gname, sizeof(header->gname), tar->sconv) != 0) {
1543		err = set_conversion_failed_error(a, tar->sconv, "Gname");
1544		if (err == ARCHIVE_FATAL)
1545			return (err);
1546	}
1547
1548	/* Parse out device numbers only for char and block specials. */
1549	if (header->typeflag[0] == '3' || header->typeflag[0] == '4') {
1550		archive_entry_set_rdevmajor(entry, (dev_t)
1551		    tar_atol(header->rdevmajor, sizeof(header->rdevmajor)));
1552		archive_entry_set_rdevminor(entry, (dev_t)
1553		    tar_atol(header->rdevminor, sizeof(header->rdevminor)));
1554	}
1555
1556	tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1557
1558	return (err);
1559}
1560
1561
1562/*
1563 * Parse the pax extended attributes record.
1564 *
1565 * Returns non-zero if there's an error in the data.
1566 */
1567static int
1568pax_header(struct archive_read *a, struct tar *tar,
1569    struct archive_entry *entry, struct archive_string *in_as)
1570{
1571	size_t attr_length, l, line_length, value_length;
1572	char *p;
1573	char *key, *value;
1574	struct archive_string *as;
1575	struct archive_string_conv *sconv;
1576	int err, err2;
1577	char *attr = in_as->s;
1578
1579	attr_length = in_as->length;
1580	tar->pax_hdrcharset_binary = 0;
1581	archive_string_empty(&(tar->entry_gname));
1582	archive_string_empty(&(tar->entry_linkpath));
1583	archive_string_empty(&(tar->entry_pathname));
1584	archive_string_empty(&(tar->entry_pathname_override));
1585	archive_string_empty(&(tar->entry_uname));
1586	err = ARCHIVE_OK;
1587	while (attr_length > 0) {
1588		/* Parse decimal length field at start of line. */
1589		line_length = 0;
1590		l = attr_length;
1591		p = attr; /* Record start of line. */
1592		while (l>0) {
1593			if (*p == ' ') {
1594				p++;
1595				l--;
1596				break;
1597			}
1598			if (*p < '0' || *p > '9') {
1599				archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1600				    "Ignoring malformed pax extended attributes");
1601				return (ARCHIVE_WARN);
1602			}
1603			line_length *= 10;
1604			line_length += *p - '0';
1605			if (line_length > 999999) {
1606				archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1607				    "Rejecting pax extended attribute > 1MB");
1608				return (ARCHIVE_WARN);
1609			}
1610			p++;
1611			l--;
1612		}
1613
1614		/*
1615		 * Parsed length must be no bigger than available data,
1616		 * at least 1, and the last character of the line must
1617		 * be '\n'.
1618		 */
1619		if (line_length > attr_length
1620		    || line_length < 1
1621		    || attr[line_length - 1] != '\n')
1622		{
1623			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1624			    "Ignoring malformed pax extended attribute");
1625			return (ARCHIVE_WARN);
1626		}
1627
1628		/* Null-terminate the line. */
1629		attr[line_length - 1] = '\0';
1630
1631		/* Find end of key and null terminate it. */
1632		key = p;
1633		if (key[0] == '=')
1634			return (-1);
1635		while (*p && *p != '=')
1636			++p;
1637		if (*p == '\0') {
1638			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1639			    "Invalid pax extended attributes");
1640			return (ARCHIVE_WARN);
1641		}
1642		*p = '\0';
1643
1644		value = p + 1;
1645
1646		/* Some values may be binary data */
1647		value_length = attr + line_length - 1 - value;
1648
1649		/* Identify this attribute and set it in the entry. */
1650		err2 = pax_attribute(a, tar, entry, key, value, value_length);
1651		if (err2 == ARCHIVE_FATAL)
1652			return (err2);
1653		err = err_combine(err, err2);
1654
1655		/* Skip to next line */
1656		attr += line_length;
1657		attr_length -= line_length;
1658	}
1659
1660	/*
1661	 * PAX format uses UTF-8 as default charset for its metadata
1662	 * unless hdrcharset=BINARY is present in its header.
1663	 * We apply the charset specified by the hdrcharset option only
1664	 * when the hdrcharset attribute(in PAX header) is BINARY because
1665	 * we respect the charset described in PAX header and BINARY also
1666	 * means that metadata(filename,uname and gname) character-set
1667	 * is unknown.
1668	 */
1669	if (tar->pax_hdrcharset_binary)
1670		sconv = tar->opt_sconv;
1671	else {
1672		sconv = archive_string_conversion_from_charset(
1673		    &(a->archive), "UTF-8", 1);
1674		if (sconv == NULL)
1675			return (ARCHIVE_FATAL);
1676		if (tar->compat_2x)
1677			archive_string_conversion_set_opt(sconv,
1678			    SCONV_SET_OPT_UTF8_LIBARCHIVE2X);
1679	}
1680
1681	if (archive_strlen(&(tar->entry_gname)) > 0) {
1682		if (archive_entry_copy_gname_l(entry, tar->entry_gname.s,
1683		    archive_strlen(&(tar->entry_gname)), sconv) != 0) {
1684			err = set_conversion_failed_error(a, sconv, "Gname");
1685			if (err == ARCHIVE_FATAL)
1686				return (err);
1687			/* Use a converted an original name. */
1688			archive_entry_copy_gname(entry, tar->entry_gname.s);
1689		}
1690	}
1691	if (archive_strlen(&(tar->entry_linkpath)) > 0) {
1692		if (archive_entry_copy_link_l(entry, tar->entry_linkpath.s,
1693		    archive_strlen(&(tar->entry_linkpath)), sconv) != 0) {
1694			err = set_conversion_failed_error(a, sconv, "Linkname");
1695			if (err == ARCHIVE_FATAL)
1696				return (err);
1697			/* Use a converted an original name. */
1698			archive_entry_copy_link(entry, tar->entry_linkpath.s);
1699		}
1700	}
1701	/*
1702	 * Some extensions (such as the GNU sparse file extensions)
1703	 * deliberately store a synthetic name under the regular 'path'
1704	 * attribute and the real file name under a different attribute.
1705	 * Since we're supposed to not care about the order, we
1706	 * have no choice but to store all of the various filenames
1707	 * we find and figure it all out afterwards.  This is the
1708	 * figuring out part.
1709	 */
1710	as = NULL;
1711	if (archive_strlen(&(tar->entry_pathname_override)) > 0)
1712		as = &(tar->entry_pathname_override);
1713	else if (archive_strlen(&(tar->entry_pathname)) > 0)
1714		as = &(tar->entry_pathname);
1715	if (as != NULL) {
1716		if (archive_entry_copy_pathname_l(entry, as->s,
1717		    archive_strlen(as), sconv) != 0) {
1718			err = set_conversion_failed_error(a, sconv, "Pathname");
1719			if (err == ARCHIVE_FATAL)
1720				return (err);
1721			/* Use a converted an original name. */
1722			archive_entry_copy_pathname(entry, as->s);
1723		}
1724	}
1725	if (archive_strlen(&(tar->entry_uname)) > 0) {
1726		if (archive_entry_copy_uname_l(entry, tar->entry_uname.s,
1727		    archive_strlen(&(tar->entry_uname)), sconv) != 0) {
1728			err = set_conversion_failed_error(a, sconv, "Uname");
1729			if (err == ARCHIVE_FATAL)
1730				return (err);
1731			/* Use a converted an original name. */
1732			archive_entry_copy_uname(entry, tar->entry_uname.s);
1733		}
1734	}
1735	return (err);
1736}
1737
1738static int
1739pax_attribute_xattr(struct archive_entry *entry,
1740	const char *name, const char *value)
1741{
1742	char *name_decoded;
1743	void *value_decoded;
1744	size_t value_len;
1745
1746	if (strlen(name) < 18 || (memcmp(name, "LIBARCHIVE.xattr.", 17)) != 0)
1747		return 3;
1748
1749	name += 17;
1750
1751	/* URL-decode name */
1752	name_decoded = url_decode(name);
1753	if (name_decoded == NULL)
1754		return 2;
1755
1756	/* Base-64 decode value */
1757	value_decoded = base64_decode(value, strlen(value), &value_len);
1758	if (value_decoded == NULL) {
1759		free(name_decoded);
1760		return 1;
1761	}
1762
1763	archive_entry_xattr_add_entry(entry, name_decoded,
1764		value_decoded, value_len);
1765
1766	free(name_decoded);
1767	free(value_decoded);
1768	return 0;
1769}
1770
1771static int
1772pax_attribute_schily_xattr(struct archive_entry *entry,
1773	const char *name, const char *value, size_t value_length)
1774{
1775	if (strlen(name) < 14 || (memcmp(name, "SCHILY.xattr.", 13)) != 0)
1776		return 1;
1777
1778	name += 13;
1779
1780	archive_entry_xattr_add_entry(entry, name, value, value_length);
1781
1782	return 0;
1783}
1784
1785static int
1786pax_attribute_acl(struct archive_read *a, struct tar *tar,
1787    struct archive_entry *entry, const char *value, int type)
1788{
1789	int r;
1790	const char* errstr;
1791
1792	switch (type) {
1793	case ARCHIVE_ENTRY_ACL_TYPE_ACCESS:
1794		errstr = "SCHILY.acl.access";
1795		break;
1796	case ARCHIVE_ENTRY_ACL_TYPE_DEFAULT:
1797		errstr = "SCHILY.acl.default";
1798		break;
1799	case ARCHIVE_ENTRY_ACL_TYPE_NFS4:
1800		errstr = "SCHILY.acl.ace";
1801		break;
1802	default:
1803		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1804		    "Unknown ACL type: %d", type);
1805		return(ARCHIVE_FATAL);
1806	}
1807
1808	if (tar->sconv_acl == NULL) {
1809		tar->sconv_acl =
1810		    archive_string_conversion_from_charset(
1811			&(a->archive), "UTF-8", 1);
1812		if (tar->sconv_acl == NULL)
1813			return (ARCHIVE_FATAL);
1814	}
1815
1816	r = archive_acl_from_text_l(archive_entry_acl(entry), value, type,
1817	    tar->sconv_acl);
1818	if (r != ARCHIVE_OK) {
1819		if (r == ARCHIVE_FATAL) {
1820			archive_set_error(&a->archive, ENOMEM,
1821			    "%s %s", "Can't allocate memory for ",
1822			    errstr);
1823			return (r);
1824		}
1825		archive_set_error(&a->archive,
1826		    ARCHIVE_ERRNO_MISC, "%s %s", "Parse error: ", errstr);
1827	}
1828	return (r);
1829}
1830
1831/*
1832 * Parse a single key=value attribute.  key/value pointers are
1833 * assumed to point into reasonably long-lived storage.
1834 *
1835 * Note that POSIX reserves all-lowercase keywords.  Vendor-specific
1836 * extensions should always have keywords of the form "VENDOR.attribute"
1837 * In particular, it's quite feasible to support many different
1838 * vendor extensions here.  I'm using "LIBARCHIVE" for extensions
1839 * unique to this library.
1840 *
1841 * Investigate other vendor-specific extensions and see if
1842 * any of them look useful.
1843 */
1844static int
1845pax_attribute(struct archive_read *a, struct tar *tar,
1846    struct archive_entry *entry, const char *key, const char *value, size_t value_length)
1847{
1848	int64_t s;
1849	long n;
1850	int err = ARCHIVE_OK, r;
1851
1852#ifndef __FreeBSD__
1853	if (value == NULL)
1854		value = "";	/* Disable compiler warning; do not pass
1855				 * NULL pointer to strlen().  */
1856#endif
1857	switch (key[0]) {
1858	case 'G':
1859		/* Reject GNU.sparse.* headers on non-regular files. */
1860		if (strncmp(key, "GNU.sparse", 10) == 0 &&
1861		    !tar->sparse_allowed) {
1862			archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1863			    "Non-regular file cannot be sparse");
1864			return (ARCHIVE_FATAL);
1865		}
1866
1867		/* GNU "0.0" sparse pax format. */
1868		if (strcmp(key, "GNU.sparse.numblocks") == 0) {
1869			tar->sparse_offset = -1;
1870			tar->sparse_numbytes = -1;
1871			tar->sparse_gnu_major = 0;
1872			tar->sparse_gnu_minor = 0;
1873		}
1874		if (strcmp(key, "GNU.sparse.offset") == 0) {
1875			tar->sparse_offset = tar_atol10(value, strlen(value));
1876			if (tar->sparse_numbytes != -1) {
1877				if (gnu_add_sparse_entry(a, tar,
1878				    tar->sparse_offset, tar->sparse_numbytes)
1879				    != ARCHIVE_OK)
1880					return (ARCHIVE_FATAL);
1881				tar->sparse_offset = -1;
1882				tar->sparse_numbytes = -1;
1883			}
1884		}
1885		if (strcmp(key, "GNU.sparse.numbytes") == 0) {
1886			tar->sparse_numbytes = tar_atol10(value, strlen(value));
1887			if (tar->sparse_numbytes != -1) {
1888				if (gnu_add_sparse_entry(a, tar,
1889				    tar->sparse_offset, tar->sparse_numbytes)
1890				    != ARCHIVE_OK)
1891					return (ARCHIVE_FATAL);
1892				tar->sparse_offset = -1;
1893				tar->sparse_numbytes = -1;
1894			}
1895		}
1896		if (strcmp(key, "GNU.sparse.size") == 0) {
1897			tar->realsize = tar_atol10(value, strlen(value));
1898			archive_entry_set_size(entry, tar->realsize);
1899		}
1900
1901		/* GNU "0.1" sparse pax format. */
1902		if (strcmp(key, "GNU.sparse.map") == 0) {
1903			tar->sparse_gnu_major = 0;
1904			tar->sparse_gnu_minor = 1;
1905			if (gnu_sparse_01_parse(a, tar, value) != ARCHIVE_OK)
1906				return (ARCHIVE_WARN);
1907		}
1908
1909		/* GNU "1.0" sparse pax format */
1910		if (strcmp(key, "GNU.sparse.major") == 0) {
1911			tar->sparse_gnu_major = (int)tar_atol10(value, strlen(value));
1912			tar->sparse_gnu_pending = 1;
1913		}
1914		if (strcmp(key, "GNU.sparse.minor") == 0) {
1915			tar->sparse_gnu_minor = (int)tar_atol10(value, strlen(value));
1916			tar->sparse_gnu_pending = 1;
1917		}
1918		if (strcmp(key, "GNU.sparse.name") == 0) {
1919			/*
1920			 * The real filename; when storing sparse
1921			 * files, GNU tar puts a synthesized name into
1922			 * the regular 'path' attribute in an attempt
1923			 * to limit confusion. ;-)
1924			 */
1925			archive_strcpy(&(tar->entry_pathname_override), value);
1926		}
1927		if (strcmp(key, "GNU.sparse.realsize") == 0) {
1928			tar->realsize = tar_atol10(value, strlen(value));
1929			archive_entry_set_size(entry, tar->realsize);
1930		}
1931		break;
1932	case 'L':
1933		/* Our extensions */
1934/* TODO: Handle arbitrary extended attributes... */
1935/*
1936		if (strcmp(key, "LIBARCHIVE.xxxxxxx") == 0)
1937			archive_entry_set_xxxxxx(entry, value);
1938*/
1939		if (strcmp(key, "LIBARCHIVE.creationtime") == 0) {
1940			pax_time(value, &s, &n);
1941			archive_entry_set_birthtime(entry, s, n);
1942		}
1943		if (memcmp(key, "LIBARCHIVE.xattr.", 17) == 0)
1944			pax_attribute_xattr(entry, key, value);
1945		break;
1946	case 'S':
1947		/* We support some keys used by the "star" archiver */
1948		if (strcmp(key, "SCHILY.acl.access") == 0) {
1949			r = pax_attribute_acl(a, tar, entry, value,
1950			    ARCHIVE_ENTRY_ACL_TYPE_ACCESS);
1951			if (r == ARCHIVE_FATAL)
1952				return (r);
1953		} else if (strcmp(key, "SCHILY.acl.default") == 0) {
1954			r = pax_attribute_acl(a, tar, entry, value,
1955			    ARCHIVE_ENTRY_ACL_TYPE_DEFAULT);
1956			if (r == ARCHIVE_FATAL)
1957				return (r);
1958		} else if (strcmp(key, "SCHILY.acl.ace") == 0) {
1959			r = pax_attribute_acl(a, tar, entry, value,
1960			    ARCHIVE_ENTRY_ACL_TYPE_NFS4);
1961			if (r == ARCHIVE_FATAL)
1962				return (r);
1963		} else if (strcmp(key, "SCHILY.devmajor") == 0) {
1964			archive_entry_set_rdevmajor(entry,
1965			    (dev_t)tar_atol10(value, strlen(value)));
1966		} else if (strcmp(key, "SCHILY.devminor") == 0) {
1967			archive_entry_set_rdevminor(entry,
1968			    (dev_t)tar_atol10(value, strlen(value)));
1969		} else if (strcmp(key, "SCHILY.fflags") == 0) {
1970			archive_entry_copy_fflags_text(entry, value);
1971		} else if (strcmp(key, "SCHILY.dev") == 0) {
1972			archive_entry_set_dev(entry,
1973			    (dev_t)tar_atol10(value, strlen(value)));
1974		} else if (strcmp(key, "SCHILY.ino") == 0) {
1975			archive_entry_set_ino(entry,
1976			    tar_atol10(value, strlen(value)));
1977		} else if (strcmp(key, "SCHILY.nlink") == 0) {
1978			archive_entry_set_nlink(entry, (unsigned)
1979			    tar_atol10(value, strlen(value)));
1980		} else if (strcmp(key, "SCHILY.realsize") == 0) {
1981			tar->realsize = tar_atol10(value, strlen(value));
1982			archive_entry_set_size(entry, tar->realsize);
1983		} else if (strncmp(key, "SCHILY.xattr.", 13) == 0) {
1984			pax_attribute_schily_xattr(entry, key, value,
1985			    value_length);
1986		} else if (strcmp(key, "SUN.holesdata") == 0) {
1987			/* A Solaris extension for sparse. */
1988			r = solaris_sparse_parse(a, tar, entry, value);
1989			if (r < err) {
1990				if (r == ARCHIVE_FATAL)
1991					return (r);
1992				err = r;
1993				archive_set_error(&a->archive,
1994				    ARCHIVE_ERRNO_MISC,
1995				    "Parse error: SUN.holesdata");
1996			}
1997		}
1998		break;
1999	case 'a':
2000		if (strcmp(key, "atime") == 0) {
2001			pax_time(value, &s, &n);
2002			archive_entry_set_atime(entry, s, n);
2003		}
2004		break;
2005	case 'c':
2006		if (strcmp(key, "ctime") == 0) {
2007			pax_time(value, &s, &n);
2008			archive_entry_set_ctime(entry, s, n);
2009		} else if (strcmp(key, "charset") == 0) {
2010			/* TODO: Publish charset information in entry. */
2011		} else if (strcmp(key, "comment") == 0) {
2012			/* TODO: Publish comment in entry. */
2013		}
2014		break;
2015	case 'g':
2016		if (strcmp(key, "gid") == 0) {
2017			archive_entry_set_gid(entry,
2018			    tar_atol10(value, strlen(value)));
2019		} else if (strcmp(key, "gname") == 0) {
2020			archive_strcpy(&(tar->entry_gname), value);
2021		}
2022		break;
2023	case 'h':
2024		if (strcmp(key, "hdrcharset") == 0) {
2025			if (strcmp(value, "BINARY") == 0)
2026				/* Binary  mode. */
2027				tar->pax_hdrcharset_binary = 1;
2028			else if (strcmp(value, "ISO-IR 10646 2000 UTF-8") == 0)
2029				tar->pax_hdrcharset_binary = 0;
2030		}
2031		break;
2032	case 'l':
2033		/* pax interchange doesn't distinguish hardlink vs. symlink. */
2034		if (strcmp(key, "linkpath") == 0) {
2035			archive_strcpy(&(tar->entry_linkpath), value);
2036		}
2037		break;
2038	case 'm':
2039		if (strcmp(key, "mtime") == 0) {
2040			pax_time(value, &s, &n);
2041			archive_entry_set_mtime(entry, s, n);
2042		}
2043		break;
2044	case 'p':
2045		if (strcmp(key, "path") == 0) {
2046			archive_strcpy(&(tar->entry_pathname), value);
2047		}
2048		break;
2049	case 'r':
2050		/* POSIX has reserved 'realtime.*' */
2051		break;
2052	case 's':
2053		/* POSIX has reserved 'security.*' */
2054		/* Someday: if (strcmp(key, "security.acl") == 0) { ... } */
2055		if (strcmp(key, "size") == 0) {
2056			/* "size" is the size of the data in the entry. */
2057			tar->entry_bytes_remaining
2058			    = tar_atol10(value, strlen(value));
2059			/*
2060			 * But, "size" is not necessarily the size of
2061			 * the file on disk; if this is a sparse file,
2062			 * the disk size may have already been set from
2063			 * GNU.sparse.realsize or GNU.sparse.size or
2064			 * an old GNU header field or SCHILY.realsize
2065			 * or ....
2066			 */
2067			if (tar->realsize < 0) {
2068				archive_entry_set_size(entry,
2069				    tar->entry_bytes_remaining);
2070				tar->realsize
2071				    = tar->entry_bytes_remaining;
2072			}
2073		}
2074		break;
2075	case 'u':
2076		if (strcmp(key, "uid") == 0) {
2077			archive_entry_set_uid(entry,
2078			    tar_atol10(value, strlen(value)));
2079		} else if (strcmp(key, "uname") == 0) {
2080			archive_strcpy(&(tar->entry_uname), value);
2081		}
2082		break;
2083	}
2084	return (err);
2085}
2086
2087
2088
2089/*
2090 * parse a decimal time value, which may include a fractional portion
2091 */
2092static void
2093pax_time(const char *p, int64_t *ps, long *pn)
2094{
2095	char digit;
2096	int64_t	s;
2097	unsigned long l;
2098	int sign;
2099	int64_t limit, last_digit_limit;
2100
2101	limit = INT64_MAX / 10;
2102	last_digit_limit = INT64_MAX % 10;
2103
2104	s = 0;
2105	sign = 1;
2106	if (*p == '-') {
2107		sign = -1;
2108		p++;
2109	}
2110	while (*p >= '0' && *p <= '9') {
2111		digit = *p - '0';
2112		if (s > limit ||
2113		    (s == limit && digit > last_digit_limit)) {
2114			s = INT64_MAX;
2115			break;
2116		}
2117		s = (s * 10) + digit;
2118		++p;
2119	}
2120
2121	*ps = s * sign;
2122
2123	/* Calculate nanoseconds. */
2124	*pn = 0;
2125
2126	if (*p != '.')
2127		return;
2128
2129	l = 100000000UL;
2130	do {
2131		++p;
2132		if (*p >= '0' && *p <= '9')
2133			*pn += (*p - '0') * l;
2134		else
2135			break;
2136	} while (l /= 10);
2137}
2138
2139/*
2140 * Parse GNU tar header
2141 */
2142static int
2143header_gnutar(struct archive_read *a, struct tar *tar,
2144    struct archive_entry *entry, const void *h, size_t *unconsumed)
2145{
2146	const struct archive_entry_header_gnutar *header;
2147	int64_t t;
2148	int err = ARCHIVE_OK;
2149
2150	/*
2151	 * GNU header is like POSIX ustar, except 'prefix' is
2152	 * replaced with some other fields. This also means the
2153	 * filename is stored as in old-style archives.
2154	 */
2155
2156	/* Grab fields common to all tar variants. */
2157	err = header_common(a, tar, entry, h);
2158	if (err == ARCHIVE_FATAL)
2159		return (err);
2160
2161	/* Copy filename over (to ensure null termination). */
2162	header = (const struct archive_entry_header_gnutar *)h;
2163	if (archive_entry_copy_pathname_l(entry,
2164	    header->name, sizeof(header->name), tar->sconv) != 0) {
2165		err = set_conversion_failed_error(a, tar->sconv, "Pathname");
2166		if (err == ARCHIVE_FATAL)
2167			return (err);
2168	}
2169
2170	/* Fields common to ustar and GNU */
2171	/* XXX Can the following be factored out since it's common
2172	 * to ustar and gnu tar?  Is it okay to move it down into
2173	 * header_common, perhaps?  */
2174	if (archive_entry_copy_uname_l(entry,
2175	    header->uname, sizeof(header->uname), tar->sconv) != 0) {
2176		err = set_conversion_failed_error(a, tar->sconv, "Uname");
2177		if (err == ARCHIVE_FATAL)
2178			return (err);
2179	}
2180
2181	if (archive_entry_copy_gname_l(entry,
2182	    header->gname, sizeof(header->gname), tar->sconv) != 0) {
2183		err = set_conversion_failed_error(a, tar->sconv, "Gname");
2184		if (err == ARCHIVE_FATAL)
2185			return (err);
2186	}
2187
2188	/* Parse out device numbers only for char and block specials */
2189	if (header->typeflag[0] == '3' || header->typeflag[0] == '4') {
2190		archive_entry_set_rdevmajor(entry, (dev_t)
2191		    tar_atol(header->rdevmajor, sizeof(header->rdevmajor)));
2192		archive_entry_set_rdevminor(entry, (dev_t)
2193		    tar_atol(header->rdevminor, sizeof(header->rdevminor)));
2194	} else
2195		archive_entry_set_rdev(entry, 0);
2196
2197	tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
2198
2199	/* Grab GNU-specific fields. */
2200	t = tar_atol(header->atime, sizeof(header->atime));
2201	if (t > 0)
2202		archive_entry_set_atime(entry, t, 0);
2203	t = tar_atol(header->ctime, sizeof(header->ctime));
2204	if (t > 0)
2205		archive_entry_set_ctime(entry, t, 0);
2206
2207	if (header->realsize[0] != 0) {
2208		tar->realsize
2209		    = tar_atol(header->realsize, sizeof(header->realsize));
2210		archive_entry_set_size(entry, tar->realsize);
2211	}
2212
2213	if (header->sparse[0].offset[0] != 0) {
2214		if (gnu_sparse_old_read(a, tar, header, unconsumed)
2215		    != ARCHIVE_OK)
2216			return (ARCHIVE_FATAL);
2217	} else {
2218		if (header->isextended[0] != 0) {
2219			/* XXX WTF? XXX */
2220		}
2221	}
2222
2223	return (err);
2224}
2225
2226static int
2227gnu_add_sparse_entry(struct archive_read *a, struct tar *tar,
2228    int64_t offset, int64_t remaining)
2229{
2230	struct sparse_block *p;
2231
2232	p = (struct sparse_block *)calloc(1, sizeof(*p));
2233	if (p == NULL) {
2234		archive_set_error(&a->archive, ENOMEM, "Out of memory");
2235		return (ARCHIVE_FATAL);
2236	}
2237	if (tar->sparse_last != NULL)
2238		tar->sparse_last->next = p;
2239	else
2240		tar->sparse_list = p;
2241	tar->sparse_last = p;
2242	if (remaining < 0 || offset < 0) {
2243		archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC, "Malformed sparse map data");
2244		return (ARCHIVE_FATAL);
2245	}
2246	p->offset = offset;
2247	p->remaining = remaining;
2248	return (ARCHIVE_OK);
2249}
2250
2251static void
2252gnu_clear_sparse_list(struct tar *tar)
2253{
2254	struct sparse_block *p;
2255
2256	while (tar->sparse_list != NULL) {
2257		p = tar->sparse_list;
2258		tar->sparse_list = p->next;
2259		free(p);
2260	}
2261	tar->sparse_last = NULL;
2262}
2263
2264/*
2265 * GNU tar old-format sparse data.
2266 *
2267 * GNU old-format sparse data is stored in a fixed-field
2268 * format.  Offset/size values are 11-byte octal fields (same
2269 * format as 'size' field in ustart header).  These are
2270 * stored in the header, allocating subsequent header blocks
2271 * as needed.  Extending the header in this way is a pretty
2272 * severe POSIX violation; this design has earned GNU tar a
2273 * lot of criticism.
2274 */
2275
2276static int
2277gnu_sparse_old_read(struct archive_read *a, struct tar *tar,
2278    const struct archive_entry_header_gnutar *header, size_t *unconsumed)
2279{
2280	ssize_t bytes_read;
2281	const void *data;
2282	struct extended {
2283		struct gnu_sparse sparse[21];
2284		char	isextended[1];
2285		char	padding[7];
2286	};
2287	const struct extended *ext;
2288
2289	if (gnu_sparse_old_parse(a, tar, header->sparse, 4) != ARCHIVE_OK)
2290		return (ARCHIVE_FATAL);
2291	if (header->isextended[0] == 0)
2292		return (ARCHIVE_OK);
2293
2294	do {
2295		tar_flush_unconsumed(a, unconsumed);
2296		data = __archive_read_ahead(a, 512, &bytes_read);
2297		if (bytes_read < 0)
2298			return (ARCHIVE_FATAL);
2299		if (bytes_read < 512) {
2300			archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
2301			    "Truncated tar archive "
2302			    "detected while reading sparse file data");
2303			return (ARCHIVE_FATAL);
2304		}
2305		*unconsumed = 512;
2306		ext = (const struct extended *)data;
2307		if (gnu_sparse_old_parse(a, tar, ext->sparse, 21) != ARCHIVE_OK)
2308			return (ARCHIVE_FATAL);
2309	} while (ext->isextended[0] != 0);
2310	if (tar->sparse_list != NULL)
2311		tar->entry_offset = tar->sparse_list->offset;
2312	return (ARCHIVE_OK);
2313}
2314
2315static int
2316gnu_sparse_old_parse(struct archive_read *a, struct tar *tar,
2317    const struct gnu_sparse *sparse, int length)
2318{
2319	while (length > 0 && sparse->offset[0] != 0) {
2320		if (gnu_add_sparse_entry(a, tar,
2321		    tar_atol(sparse->offset, sizeof(sparse->offset)),
2322		    tar_atol(sparse->numbytes, sizeof(sparse->numbytes)))
2323		    != ARCHIVE_OK)
2324			return (ARCHIVE_FATAL);
2325		sparse++;
2326		length--;
2327	}
2328	return (ARCHIVE_OK);
2329}
2330
2331/*
2332 * GNU tar sparse format 0.0
2333 *
2334 * Beginning with GNU tar 1.15, sparse files are stored using
2335 * information in the pax extended header.  The GNU tar maintainers
2336 * have gone through a number of variations in the process of working
2337 * out this scheme; fortunately, they're all numbered.
2338 *
2339 * Sparse format 0.0 uses attribute GNU.sparse.numblocks to store the
2340 * number of blocks, and GNU.sparse.offset/GNU.sparse.numbytes to
2341 * store offset/size for each block.  The repeated instances of these
2342 * latter fields violate the pax specification (which frowns on
2343 * duplicate keys), so this format was quickly replaced.
2344 */
2345
2346/*
2347 * GNU tar sparse format 0.1
2348 *
2349 * This version replaced the offset/numbytes attributes with
2350 * a single "map" attribute that stored a list of integers.  This
2351 * format had two problems: First, the "map" attribute could be very
2352 * long, which caused problems for some implementations.  More
2353 * importantly, the sparse data was lost when extracted by archivers
2354 * that didn't recognize this extension.
2355 */
2356
2357static int
2358gnu_sparse_01_parse(struct archive_read *a, struct tar *tar, const char *p)
2359{
2360	const char *e;
2361	int64_t offset = -1, size = -1;
2362
2363	for (;;) {
2364		e = p;
2365		while (*e != '\0' && *e != ',') {
2366			if (*e < '0' || *e > '9')
2367				return (ARCHIVE_WARN);
2368			e++;
2369		}
2370		if (offset < 0) {
2371			offset = tar_atol10(p, e - p);
2372			if (offset < 0)
2373				return (ARCHIVE_WARN);
2374		} else {
2375			size = tar_atol10(p, e - p);
2376			if (size < 0)
2377				return (ARCHIVE_WARN);
2378			if (gnu_add_sparse_entry(a, tar, offset, size)
2379			    != ARCHIVE_OK)
2380				return (ARCHIVE_FATAL);
2381			offset = -1;
2382		}
2383		if (*e == '\0')
2384			return (ARCHIVE_OK);
2385		p = e + 1;
2386	}
2387}
2388
2389/*
2390 * GNU tar sparse format 1.0
2391 *
2392 * The idea: The offset/size data is stored as a series of base-10
2393 * ASCII numbers prepended to the file data, so that dearchivers that
2394 * don't support this format will extract the block map along with the
2395 * data and a separate post-process can restore the sparseness.
2396 *
2397 * Unfortunately, GNU tar 1.16 had a bug that added unnecessary
2398 * padding to the body of the file when using this format.  GNU tar
2399 * 1.17 corrected this bug without bumping the version number, so
2400 * it's not possible to support both variants.  This code supports
2401 * the later variant at the expense of not supporting the former.
2402 *
2403 * This variant also replaced GNU.sparse.size with GNU.sparse.realsize
2404 * and introduced the GNU.sparse.major/GNU.sparse.minor attributes.
2405 */
2406
2407/*
2408 * Read the next line from the input, and parse it as a decimal
2409 * integer followed by '\n'.  Returns positive integer value or
2410 * negative on error.
2411 */
2412static int64_t
2413gnu_sparse_10_atol(struct archive_read *a, struct tar *tar,
2414    int64_t *remaining, size_t *unconsumed)
2415{
2416	int64_t l, limit, last_digit_limit;
2417	const char *p;
2418	ssize_t bytes_read;
2419	int base, digit;
2420
2421	base = 10;
2422	limit = INT64_MAX / base;
2423	last_digit_limit = INT64_MAX % base;
2424
2425	/*
2426	 * Skip any lines starting with '#'; GNU tar specs
2427	 * don't require this, but they should.
2428	 */
2429	do {
2430		bytes_read = readline(a, tar, &p,
2431			(ssize_t)tar_min(*remaining, 100), unconsumed);
2432		if (bytes_read <= 0)
2433			return (ARCHIVE_FATAL);
2434		*remaining -= bytes_read;
2435	} while (p[0] == '#');
2436
2437	l = 0;
2438	while (bytes_read > 0) {
2439		if (*p == '\n')
2440			return (l);
2441		if (*p < '0' || *p >= '0' + base)
2442			return (ARCHIVE_WARN);
2443		digit = *p - '0';
2444		if (l > limit || (l == limit && digit > last_digit_limit))
2445			l = INT64_MAX; /* Truncate on overflow. */
2446		else
2447			l = (l * base) + digit;
2448		p++;
2449		bytes_read--;
2450	}
2451	/* TODO: Error message. */
2452	return (ARCHIVE_WARN);
2453}
2454
2455/*
2456 * Returns length (in bytes) of the sparse data description
2457 * that was read.
2458 */
2459static ssize_t
2460gnu_sparse_10_read(struct archive_read *a, struct tar *tar, size_t *unconsumed)
2461{
2462	ssize_t bytes_read;
2463	int entries;
2464	int64_t offset, size, to_skip, remaining;
2465
2466	/* Clear out the existing sparse list. */
2467	gnu_clear_sparse_list(tar);
2468
2469	remaining = tar->entry_bytes_remaining;
2470
2471	/* Parse entries. */
2472	entries = (int)gnu_sparse_10_atol(a, tar, &remaining, unconsumed);
2473	if (entries < 0)
2474		return (ARCHIVE_FATAL);
2475	/* Parse the individual entries. */
2476	while (entries-- > 0) {
2477		/* Parse offset/size */
2478		offset = gnu_sparse_10_atol(a, tar, &remaining, unconsumed);
2479		if (offset < 0)
2480			return (ARCHIVE_FATAL);
2481		size = gnu_sparse_10_atol(a, tar, &remaining, unconsumed);
2482		if (size < 0)
2483			return (ARCHIVE_FATAL);
2484		/* Add a new sparse entry. */
2485		if (gnu_add_sparse_entry(a, tar, offset, size) != ARCHIVE_OK)
2486			return (ARCHIVE_FATAL);
2487	}
2488	/* Skip rest of block... */
2489	tar_flush_unconsumed(a, unconsumed);
2490	bytes_read = (ssize_t)(tar->entry_bytes_remaining - remaining);
2491	to_skip = 0x1ff & -bytes_read;
2492	/* Fail if tar->entry_bytes_remaing would get negative */
2493	if (to_skip > remaining)
2494		return (ARCHIVE_FATAL);
2495	if (to_skip != __archive_read_consume(a, to_skip))
2496		return (ARCHIVE_FATAL);
2497	return ((ssize_t)(bytes_read + to_skip));
2498}
2499
2500/*
2501 * Solaris pax extension for a sparse file. This is recorded with the
2502 * data and hole pairs. The way recording sparse information by Solaris'
2503 * pax simply indicates where data and sparse are, so the stored contents
2504 * consist of both data and hole.
2505 */
2506static int
2507solaris_sparse_parse(struct archive_read *a, struct tar *tar,
2508    struct archive_entry *entry, const char *p)
2509{
2510	const char *e;
2511	int64_t start, end;
2512	int hole = 1;
2513
2514	(void)entry; /* UNUSED */
2515
2516	end = 0;
2517	if (*p == ' ')
2518		p++;
2519	else
2520		return (ARCHIVE_WARN);
2521	for (;;) {
2522		e = p;
2523		while (*e != '\0' && *e != ' ') {
2524			if (*e < '0' || *e > '9')
2525				return (ARCHIVE_WARN);
2526			e++;
2527		}
2528		start = end;
2529		end = tar_atol10(p, e - p);
2530		if (end < 0)
2531			return (ARCHIVE_WARN);
2532		if (start < end) {
2533			if (gnu_add_sparse_entry(a, tar, start,
2534			    end - start) != ARCHIVE_OK)
2535				return (ARCHIVE_FATAL);
2536			tar->sparse_last->hole = hole;
2537		}
2538		if (*e == '\0')
2539			return (ARCHIVE_OK);
2540		p = e + 1;
2541		hole = hole == 0;
2542	}
2543}
2544
2545/*-
2546 * Convert text->integer.
2547 *
2548 * Traditional tar formats (including POSIX) specify base-8 for
2549 * all of the standard numeric fields.  This is a significant limitation
2550 * in practice:
2551 *   = file size is limited to 8GB
2552 *   = rdevmajor and rdevminor are limited to 21 bits
2553 *   = uid/gid are limited to 21 bits
2554 *
2555 * There are two workarounds for this:
2556 *   = pax extended headers, which use variable-length string fields
2557 *   = GNU tar and STAR both allow either base-8 or base-256 in
2558 *      most fields.  The high bit is set to indicate base-256.
2559 *
2560 * On read, this implementation supports both extensions.
2561 */
2562static int64_t
2563tar_atol(const char *p, size_t char_cnt)
2564{
2565	/*
2566	 * Technically, GNU tar considers a field to be in base-256
2567	 * only if the first byte is 0xff or 0x80.
2568	 */
2569	if (*p & 0x80)
2570		return (tar_atol256(p, char_cnt));
2571	return (tar_atol8(p, char_cnt));
2572}
2573
2574/*
2575 * Note that this implementation does not (and should not!) obey
2576 * locale settings; you cannot simply substitute strtol here, since
2577 * it does obey locale.
2578 */
2579static int64_t
2580tar_atol_base_n(const char *p, size_t char_cnt, int base)
2581{
2582	int64_t	l, maxval, limit, last_digit_limit;
2583	int digit, sign;
2584
2585	maxval = INT64_MAX;
2586	limit = INT64_MAX / base;
2587	last_digit_limit = INT64_MAX % base;
2588
2589	/* the pointer will not be dereferenced if char_cnt is zero
2590	 * due to the way the && operator is evaluated.
2591	 */
2592	while (char_cnt != 0 && (*p == ' ' || *p == '\t')) {
2593		p++;
2594		char_cnt--;
2595	}
2596
2597	sign = 1;
2598	if (char_cnt != 0 && *p == '-') {
2599		sign = -1;
2600		p++;
2601		char_cnt--;
2602
2603		maxval = INT64_MIN;
2604		limit = -(INT64_MIN / base);
2605		last_digit_limit = INT64_MIN % base;
2606	}
2607
2608	l = 0;
2609	if (char_cnt != 0) {
2610		digit = *p - '0';
2611		while (digit >= 0 && digit < base  && char_cnt != 0) {
2612			if (l>limit || (l == limit && digit > last_digit_limit)) {
2613				return maxval; /* Truncate on overflow. */
2614			}
2615			l = (l * base) + digit;
2616			digit = *++p - '0';
2617			char_cnt--;
2618		}
2619	}
2620	return (sign < 0) ? -l : l;
2621}
2622
2623static int64_t
2624tar_atol8(const char *p, size_t char_cnt)
2625{
2626	return tar_atol_base_n(p, char_cnt, 8);
2627}
2628
2629static int64_t
2630tar_atol10(const char *p, size_t char_cnt)
2631{
2632	return tar_atol_base_n(p, char_cnt, 10);
2633}
2634
2635/*
2636 * Parse a base-256 integer.  This is just a variable-length
2637 * twos-complement signed binary value in big-endian order, except
2638 * that the high-order bit is ignored.  The values here can be up to
2639 * 12 bytes, so we need to be careful about overflowing 64-bit
2640 * (8-byte) integers.
2641 *
2642 * This code unashamedly assumes that the local machine uses 8-bit
2643 * bytes and twos-complement arithmetic.
2644 */
2645static int64_t
2646tar_atol256(const char *_p, size_t char_cnt)
2647{
2648	uint64_t l;
2649	const unsigned char *p = (const unsigned char *)_p;
2650	unsigned char c, neg;
2651
2652	/* Extend 7-bit 2s-comp to 8-bit 2s-comp, decide sign. */
2653	c = *p;
2654	if (c & 0x40) {
2655		neg = 0xff;
2656		c |= 0x80;
2657		l = ~ARCHIVE_LITERAL_ULL(0);
2658	} else {
2659		neg = 0;
2660		c &= 0x7f;
2661		l = 0;
2662	}
2663
2664	/* If more than 8 bytes, check that we can ignore
2665	 * high-order bits without overflow. */
2666	while (char_cnt > sizeof(int64_t)) {
2667		--char_cnt;
2668		if (c != neg)
2669			return neg ? INT64_MIN : INT64_MAX;
2670		c = *++p;
2671	}
2672
2673	/* c is first byte that fits; if sign mismatch, return overflow */
2674	if ((c ^ neg) & 0x80) {
2675		return neg ? INT64_MIN : INT64_MAX;
2676	}
2677
2678	/* Accumulate remaining bytes. */
2679	while (--char_cnt > 0) {
2680		l = (l << 8) | c;
2681		c = *++p;
2682	}
2683	l = (l << 8) | c;
2684	/* Return signed twos-complement value. */
2685	return (int64_t)(l);
2686}
2687
2688/*
2689 * Returns length of line (including trailing newline)
2690 * or negative on error.  'start' argument is updated to
2691 * point to first character of line.  This avoids copying
2692 * when possible.
2693 */
2694static ssize_t
2695readline(struct archive_read *a, struct tar *tar, const char **start,
2696    ssize_t limit, size_t *unconsumed)
2697{
2698	ssize_t bytes_read;
2699	ssize_t total_size = 0;
2700	const void *t;
2701	const char *s;
2702	void *p;
2703
2704	tar_flush_unconsumed(a, unconsumed);
2705
2706	t = __archive_read_ahead(a, 1, &bytes_read);
2707	if (bytes_read <= 0)
2708		return (ARCHIVE_FATAL);
2709	s = t;  /* Start of line? */
2710	p = memchr(t, '\n', bytes_read);
2711	/* If we found '\n' in the read buffer, return pointer to that. */
2712	if (p != NULL) {
2713		bytes_read = 1 + ((const char *)p) - s;
2714		if (bytes_read > limit) {
2715			archive_set_error(&a->archive,
2716			    ARCHIVE_ERRNO_FILE_FORMAT,
2717			    "Line too long");
2718			return (ARCHIVE_FATAL);
2719		}
2720		*unconsumed = bytes_read;
2721		*start = s;
2722		return (bytes_read);
2723	}
2724	*unconsumed = bytes_read;
2725	/* Otherwise, we need to accumulate in a line buffer. */
2726	for (;;) {
2727		if (total_size + bytes_read > limit) {
2728			archive_set_error(&a->archive,
2729			    ARCHIVE_ERRNO_FILE_FORMAT,
2730			    "Line too long");
2731			return (ARCHIVE_FATAL);
2732		}
2733		if (archive_string_ensure(&tar->line, total_size + bytes_read) == NULL) {
2734			archive_set_error(&a->archive, ENOMEM,
2735			    "Can't allocate working buffer");
2736			return (ARCHIVE_FATAL);
2737		}
2738		memcpy(tar->line.s + total_size, t, bytes_read);
2739		tar_flush_unconsumed(a, unconsumed);
2740		total_size += bytes_read;
2741		/* If we found '\n', clean up and return. */
2742		if (p != NULL) {
2743			*start = tar->line.s;
2744			return (total_size);
2745		}
2746		/* Read some more. */
2747		t = __archive_read_ahead(a, 1, &bytes_read);
2748		if (bytes_read <= 0)
2749			return (ARCHIVE_FATAL);
2750		s = t;  /* Start of line? */
2751		p = memchr(t, '\n', bytes_read);
2752		/* If we found '\n', trim the read. */
2753		if (p != NULL) {
2754			bytes_read = 1 + ((const char *)p) - s;
2755		}
2756		*unconsumed = bytes_read;
2757	}
2758}
2759
2760/*
2761 * base64_decode - Base64 decode
2762 *
2763 * This accepts most variations of base-64 encoding, including:
2764 *    * with or without line breaks
2765 *    * with or without the final group padded with '=' or '_' characters
2766 * (The most economical Base-64 variant does not pad the last group and
2767 * omits line breaks; RFC1341 used for MIME requires both.)
2768 */
2769static char *
2770base64_decode(const char *s, size_t len, size_t *out_len)
2771{
2772	static const unsigned char digits[64] = {
2773		'A','B','C','D','E','F','G','H','I','J','K','L','M','N',
2774		'O','P','Q','R','S','T','U','V','W','X','Y','Z','a','b',
2775		'c','d','e','f','g','h','i','j','k','l','m','n','o','p',
2776		'q','r','s','t','u','v','w','x','y','z','0','1','2','3',
2777		'4','5','6','7','8','9','+','/' };
2778	static unsigned char decode_table[128];
2779	char *out, *d;
2780	const unsigned char *src = (const unsigned char *)s;
2781
2782	/* If the decode table is not yet initialized, prepare it. */
2783	if (decode_table[digits[1]] != 1) {
2784		unsigned i;
2785		memset(decode_table, 0xff, sizeof(decode_table));
2786		for (i = 0; i < sizeof(digits); i++)
2787			decode_table[digits[i]] = i;
2788	}
2789
2790	/* Allocate enough space to hold the entire output. */
2791	/* Note that we may not use all of this... */
2792	out = (char *)malloc(len - len / 4 + 1);
2793	if (out == NULL) {
2794		*out_len = 0;
2795		return (NULL);
2796	}
2797	d = out;
2798
2799	while (len > 0) {
2800		/* Collect the next group of (up to) four characters. */
2801		int v = 0;
2802		int group_size = 0;
2803		while (group_size < 4 && len > 0) {
2804			/* '=' or '_' padding indicates final group. */
2805			if (*src == '=' || *src == '_') {
2806				len = 0;
2807				break;
2808			}
2809			/* Skip illegal characters (including line breaks) */
2810			if (*src > 127 || *src < 32
2811			    || decode_table[*src] == 0xff) {
2812				len--;
2813				src++;
2814				continue;
2815			}
2816			v <<= 6;
2817			v |= decode_table[*src++];
2818			len --;
2819			group_size++;
2820		}
2821		/* Align a short group properly. */
2822		v <<= 6 * (4 - group_size);
2823		/* Unpack the group we just collected. */
2824		switch (group_size) {
2825		case 4: d[2] = v & 0xff;
2826			/* FALLTHROUGH */
2827		case 3: d[1] = (v >> 8) & 0xff;
2828			/* FALLTHROUGH */
2829		case 2: d[0] = (v >> 16) & 0xff;
2830			break;
2831		case 1: /* this is invalid! */
2832			break;
2833		}
2834		d += group_size * 3 / 4;
2835	}
2836
2837	*out_len = d - out;
2838	return (out);
2839}
2840
2841static char *
2842url_decode(const char *in)
2843{
2844	char *out, *d;
2845	const char *s;
2846
2847	out = (char *)malloc(strlen(in) + 1);
2848	if (out == NULL)
2849		return (NULL);
2850	for (s = in, d = out; *s != '\0'; ) {
2851		if (s[0] == '%' && s[1] != '\0' && s[2] != '\0') {
2852			/* Try to convert % escape */
2853			int digit1 = tohex(s[1]);
2854			int digit2 = tohex(s[2]);
2855			if (digit1 >= 0 && digit2 >= 0) {
2856				/* Looks good, consume three chars */
2857				s += 3;
2858				/* Convert output */
2859				*d++ = ((digit1 << 4) | digit2);
2860				continue;
2861			}
2862			/* Else fall through and treat '%' as normal char */
2863		}
2864		*d++ = *s++;
2865	}
2866	*d = '\0';
2867	return (out);
2868}
2869
2870static int
2871tohex(int c)
2872{
2873	if (c >= '0' && c <= '9')
2874		return (c - '0');
2875	else if (c >= 'A' && c <= 'F')
2876		return (c - 'A' + 10);
2877	else if (c >= 'a' && c <= 'f')
2878		return (c - 'a' + 10);
2879	else
2880		return (-1);
2881}
2882