Synchronous libarchive to 2.2.4 from FreeBSD, including fixes related to
[dragonfly.git] / contrib / libarchive-2 / libarchive / archive_read_support_format_tar.c
1 /*-
2  * Copyright (c) 2003-2007 Tim Kientzle
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "archive_platform.h"
27 __FBSDID("$FreeBSD: src/lib/libarchive/archive_read_support_format_tar.c,v 1.58 2007/07/12 15:00:28 cperciva Exp $");
28
29 #ifdef HAVE_ERRNO_H
30 #include <errno.h>
31 #endif
32 #include <stddef.h>
33 /* #include <stdint.h> */ /* See archive_platform.h */
34 #ifdef HAVE_STDLIB_H
35 #include <stdlib.h>
36 #endif
37 #ifdef HAVE_STRING_H
38 #include <string.h>
39 #endif
40
41 /* Obtain suitable wide-character manipulation functions. */
42 #ifdef HAVE_WCHAR_H
43 #include <wchar.h>
44 #else
45 /* Good enough for equality testing, which is all we need. */
46 static int wcscmp(const wchar_t *s1, const wchar_t *s2)
47 {
48         int diff = *s1 - *s2;
49         while (*s1 && diff == 0)
50                 diff = (int)*++s1 - (int)*++s2;
51         return diff;
52 }
53 /* Good enough for equality testing, which is all we need. */
54 static int wcsncmp(const wchar_t *s1, const wchar_t *s2, size_t n)
55 {
56         int diff = *s1 - *s2;
57         while (*s1 && diff == 0 && n-- > 0)
58                 diff = (int)*++s1 - (int)*++s2;
59         return diff;
60 }
61 static size_t wcslen(const wchar_t *s)
62 {
63         const wchar_t *p = s;
64         while (*p)
65                 p++;
66         return p - s;
67 }
68 #endif
69
70 #include "archive.h"
71 #include "archive_entry.h"
72 #include "archive_private.h"
73 #include "archive_read_private.h"
74
75 /*
76  * Layout of POSIX 'ustar' tar header.
77  */
78 struct archive_entry_header_ustar {
79         char    name[100];
80         char    mode[8];
81         char    uid[8];
82         char    gid[8];
83         char    size[12];
84         char    mtime[12];
85         char    checksum[8];
86         char    typeflag[1];
87         char    linkname[100];  /* "old format" header ends here */
88         char    magic[6];       /* For POSIX: "ustar\0" */
89         char    version[2];     /* For POSIX: "00" */
90         char    uname[32];
91         char    gname[32];
92         char    rdevmajor[8];
93         char    rdevminor[8];
94         char    prefix[155];
95 };
96
97 /*
98  * Structure of GNU tar header
99  */
100 struct gnu_sparse {
101         char    offset[12];
102         char    numbytes[12];
103 };
104
105 struct archive_entry_header_gnutar {
106         char    name[100];
107         char    mode[8];
108         char    uid[8];
109         char    gid[8];
110         char    size[12];
111         char    mtime[12];
112         char    checksum[8];
113         char    typeflag[1];
114         char    linkname[100];
115         char    magic[8];  /* "ustar  \0" (note blank/blank/null at end) */
116         char    uname[32];
117         char    gname[32];
118         char    rdevmajor[8];
119         char    rdevminor[8];
120         char    atime[12];
121         char    ctime[12];
122         char    offset[12];
123         char    longnames[4];
124         char    unused[1];
125         struct gnu_sparse sparse[4];
126         char    isextended[1];
127         char    realsize[12];
128         /*
129          * GNU doesn't use POSIX 'prefix' field; they use the 'L' (longname)
130          * entry instead.
131          */
132 };
133
134 /*
135  * Data specific to this format.
136  */
137 struct sparse_block {
138         struct sparse_block     *next;
139         off_t   offset;
140         off_t   remaining;
141 };
142
143 struct tar {
144         struct archive_string    acl_text;
145         struct archive_string    entry_name;
146         struct archive_string    entry_linkname;
147         struct archive_string    entry_uname;
148         struct archive_string    entry_gname;
149         struct archive_string    longlink;
150         struct archive_string    longname;
151         struct archive_string    pax_header;
152         struct archive_string    pax_global;
153         struct archive_string    line;
154         wchar_t                 *pax_entry;
155         size_t                   pax_entry_length;
156         int                      header_recursion_depth;
157         off_t                    entry_bytes_remaining;
158         off_t                    entry_offset;
159         off_t                    entry_padding;
160         off_t                    realsize;
161         struct sparse_block     *sparse_list;
162         struct sparse_block     *sparse_last;
163         int64_t                  sparse_offset;
164         int64_t                  sparse_numbytes;
165         int                      sparse_gnu_major;
166         int                      sparse_gnu_minor;
167         char                     sparse_gnu_pending;
168 };
169
170 static size_t   UTF8_mbrtowc(wchar_t *pwc, const char *s, size_t n);
171 static int      archive_block_is_null(const unsigned char *p);
172 static char     *base64_decode(const wchar_t *, size_t, size_t *);
173 static void      gnu_add_sparse_entry(struct tar *,
174                     off_t offset, off_t remaining);
175 static int      gnu_sparse_old_read(struct archive_read *, struct tar *,
176                     const struct archive_entry_header_gnutar *header);
177 static void     gnu_sparse_old_parse(struct tar *,
178                     const struct gnu_sparse *sparse, int length);
179 static int      gnu_sparse_01_parse(struct tar *, const wchar_t *);
180 static ssize_t  gnu_sparse_10_read(struct archive_read *, struct tar *);
181 static int      header_Solaris_ACL(struct archive_read *,  struct tar *,
182                     struct archive_entry *, const void *);
183 static int      header_common(struct archive_read *,  struct tar *,
184                     struct archive_entry *, const void *);
185 static int      header_old_tar(struct archive_read *, struct tar *,
186                     struct archive_entry *, const void *);
187 static int      header_pax_extensions(struct archive_read *, struct tar *,
188                     struct archive_entry *, const void *);
189 static int      header_pax_global(struct archive_read *, struct tar *,
190                     struct archive_entry *, const void *h);
191 static int      header_longlink(struct archive_read *, struct tar *,
192                     struct archive_entry *, const void *h);
193 static int      header_longname(struct archive_read *, struct tar *,
194                     struct archive_entry *, const void *h);
195 static int      header_volume(struct archive_read *, struct tar *,
196                     struct archive_entry *, const void *h);
197 static int      header_ustar(struct archive_read *, struct tar *,
198                     struct archive_entry *, const void *h);
199 static int      header_gnutar(struct archive_read *, struct tar *,
200                     struct archive_entry *, const void *h);
201 static int      archive_read_format_tar_bid(struct archive_read *);
202 static int      archive_read_format_tar_cleanup(struct archive_read *);
203 static int      archive_read_format_tar_read_data(struct archive_read *a,
204                     const void **buff, size_t *size, off_t *offset);
205 static int      archive_read_format_tar_skip(struct archive_read *a);
206 static int      archive_read_format_tar_read_header(struct archive_read *,
207                     struct archive_entry *);
208 static int      checksum(struct archive_read *, const void *);
209 static int      pax_attribute(struct tar *, struct archive_entry *,
210                     wchar_t *key, wchar_t *value);
211 static int      pax_header(struct archive_read *, struct tar *,
212                     struct archive_entry *, char *attr);
213 static void     pax_time(const wchar_t *, int64_t *sec, long *nanos);
214 static ssize_t  readline(struct archive_read *, struct tar *, const char **);
215 static int      read_body_to_string(struct archive_read *, struct tar *,
216                     struct archive_string *, const void *h);
217 static int64_t  tar_atol(const char *, unsigned);
218 static int64_t  tar_atol10(const wchar_t *, unsigned);
219 static int64_t  tar_atol256(const char *, unsigned);
220 static int64_t  tar_atol8(const char *, unsigned);
221 static int      tar_read_header(struct archive_read *, struct tar *,
222                     struct archive_entry *);
223 static int      tohex(int c);
224 static char     *url_decode(const char *);
225 static int      utf8_decode(wchar_t *, const char *, size_t length);
226 static char     *wide_to_narrow(const wchar_t *wval);
227
228 int
229 archive_read_support_format_gnutar(struct archive *a)
230 {
231         return (archive_read_support_format_tar(a));
232 }
233
234
235 int
236 archive_read_support_format_tar(struct archive *_a)
237 {
238         struct archive_read *a = (struct archive_read *)_a;
239         struct tar *tar;
240         int r;
241
242         tar = (struct tar *)malloc(sizeof(*tar));
243         if (tar == NULL) {
244                 archive_set_error(&a->archive, ENOMEM,
245                     "Can't allocate tar data");
246                 return (ARCHIVE_FATAL);
247         }
248         memset(tar, 0, sizeof(*tar));
249
250         r = __archive_read_register_format(a, tar,
251             archive_read_format_tar_bid,
252             archive_read_format_tar_read_header,
253             archive_read_format_tar_read_data,
254             archive_read_format_tar_skip,
255             archive_read_format_tar_cleanup);
256
257         if (r != ARCHIVE_OK)
258                 free(tar);
259         return (ARCHIVE_OK);
260 }
261
262 static int
263 archive_read_format_tar_cleanup(struct archive_read *a)
264 {
265         struct tar *tar;
266         struct sparse_block *p;
267
268         tar = (struct tar *)(a->format->data);
269         while (tar->sparse_list != NULL) {
270                 p = tar->sparse_list;
271                 tar->sparse_list = p->next;
272                 free(p);
273         }
274         archive_string_free(&tar->acl_text);
275         archive_string_free(&tar->entry_name);
276         archive_string_free(&tar->entry_linkname);
277         archive_string_free(&tar->entry_uname);
278         archive_string_free(&tar->entry_gname);
279         archive_string_free(&tar->line);
280         archive_string_free(&tar->pax_global);
281         archive_string_free(&tar->pax_header);
282         free(tar->pax_entry);
283         free(tar);
284         (a->format->data) = NULL;
285         return (ARCHIVE_OK);
286 }
287
288
289 static int
290 archive_read_format_tar_bid(struct archive_read *a)
291 {
292         int bid;
293         ssize_t bytes_read;
294         const void *h;
295         const struct archive_entry_header_ustar *header;
296
297         /*
298          * If we're already reading a non-tar file, don't
299          * bother to bid.
300          */
301         if (a->archive.archive_format != 0 &&
302             (a->archive.archive_format & ARCHIVE_FORMAT_BASE_MASK) !=
303             ARCHIVE_FORMAT_TAR)
304                 return (0);
305         bid = 0;
306
307         /*
308          * If we're already reading a tar format, start the bid at 1 as
309          * a failsafe.
310          */
311         if ((a->archive.archive_format & ARCHIVE_FORMAT_BASE_MASK) ==
312             ARCHIVE_FORMAT_TAR)
313                 bid++;
314
315         /* Now let's look at the actual header and see if it matches. */
316         if (a->decompressor->read_ahead != NULL)
317                 bytes_read = (a->decompressor->read_ahead)(a, &h, 512);
318         else
319                 bytes_read = 0; /* Empty file. */
320         if (bytes_read < 0)
321                 return (ARCHIVE_FATAL);
322         if (bytes_read == 0  &&  bid > 0) {
323                 /* An archive without a proper end-of-archive marker. */
324                 /* Hold our nose and bid 1 anyway. */
325                 return (1);
326         }
327         if (bytes_read < 512) {
328                 /* If it's a new archive, then just return a zero bid. */
329                 if (bid == 0)
330                         return (0);
331                 /*
332                  * If we already know this is a tar archive,
333                  * then we have a problem.
334                  */
335                 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
336                     "Truncated tar archive");
337                 return (ARCHIVE_FATAL);
338         }
339
340         /* If it's an end-of-archive mark, we can handle it. */
341         if ((*(const char *)h) == 0 && archive_block_is_null((const unsigned char *)h)) {
342                 /* If it's a known tar file, end-of-archive is definite. */
343                 if ((a->archive.archive_format & ARCHIVE_FORMAT_BASE_MASK) ==
344                     ARCHIVE_FORMAT_TAR)
345                         return (512);
346                 /* Empty archive? */
347                 return (1);
348         }
349
350         /* If it's not an end-of-archive mark, it must have a valid checksum.*/
351         if (!checksum(a, h))
352                 return (0);
353         bid += 48;  /* Checksum is usually 6 octal digits. */
354
355         header = (const struct archive_entry_header_ustar *)h;
356
357         /* Recognize POSIX formats. */
358         if ((memcmp(header->magic, "ustar\0", 6) == 0)
359             &&(memcmp(header->version, "00", 2)==0))
360                 bid += 56;
361
362         /* Recognize GNU tar format. */
363         if ((memcmp(header->magic, "ustar ", 6) == 0)
364             &&(memcmp(header->version, " \0", 2)==0))
365                 bid += 56;
366
367         /* Type flag must be null, digit or A-Z, a-z. */
368         if (header->typeflag[0] != 0 &&
369             !( header->typeflag[0] >= '0' && header->typeflag[0] <= '9') &&
370             !( header->typeflag[0] >= 'A' && header->typeflag[0] <= 'Z') &&
371             !( header->typeflag[0] >= 'a' && header->typeflag[0] <= 'z') )
372                 return (0);
373         bid += 2;  /* 6 bits of variation in an 8-bit field leaves 2 bits. */
374
375         /* Sanity check: Look at first byte of mode field. */
376         switch (255 & (unsigned)header->mode[0]) {
377         case 0: case 255:
378                 /* Base-256 value: No further verification possible! */
379                 break;
380         case ' ': /* Not recommended, but not illegal, either. */
381                 break;
382         case '0': case '1': case '2': case '3':
383         case '4': case '5': case '6': case '7':
384                 /* Octal Value. */
385                 /* TODO: Check format of remainder of this field. */
386                 break;
387         default:
388                 /* Not a valid mode; bail out here. */
389                 return (0);
390         }
391         /* TODO: Sanity test uid/gid/size/mtime/rdevmajor/rdevminor fields. */
392
393         return (bid);
394 }
395
396 /*
397  * The function invoked by archive_read_header().  This
398  * just sets up a few things and then calls the internal
399  * tar_read_header() function below.
400  */
401 static int
402 archive_read_format_tar_read_header(struct archive_read *a,
403     struct archive_entry *entry)
404 {
405         /*
406          * When converting tar archives to cpio archives, it is
407          * essential that each distinct file have a distinct inode
408          * number.  To simplify this, we keep a static count here to
409          * assign fake dev/inode numbers to each tar entry.  Note that
410          * pax format archives may overwrite this with something more
411          * useful.
412          *
413          * Ideally, we would track every file read from the archive so
414          * that we could assign the same dev/ino pair to hardlinks,
415          * but the memory required to store a complete lookup table is
416          * probably not worthwhile just to support the relatively
417          * obscure tar->cpio conversion case.
418          */
419         static int default_inode;
420         static int default_dev;
421         struct tar *tar;
422         struct sparse_block *sp;
423         const char *p;
424         int r;
425         size_t l;
426         ssize_t size;
427
428         /* Assign default device/inode values. */
429         archive_entry_set_dev(entry, 1 + default_dev); /* Don't use zero. */
430         archive_entry_set_ino(entry, ++default_inode); /* Don't use zero. */
431         /* Limit generated st_ino number to 16 bits. */
432         if (default_inode >= 0xffff) {
433                 ++default_dev;
434                 default_inode = 0;
435         }
436
437         tar = (struct tar *)(a->format->data);
438         tar->entry_offset = 0;
439         while (tar->sparse_list != NULL) {
440                 sp = tar->sparse_list;
441                 tar->sparse_list = sp->next;
442                 free(sp);
443         }
444         tar->sparse_last = NULL;
445
446         r = tar_read_header(a, tar, entry);
447
448         /*
449          * Yuck.  See comments for gnu_sparse_10_read for why this
450          * is here and not in _read_data where it "should" go.
451          */
452         if (tar->sparse_gnu_pending
453             && tar->sparse_gnu_major == 1
454             && tar->sparse_gnu_minor == 0) {
455                 tar->sparse_gnu_pending = 0;
456                 /* Read initial sparse map. */
457                 size = gnu_sparse_10_read(a, tar);
458                 if (size < 0)
459                         return (size);
460                 tar->entry_bytes_remaining -= size;
461                 tar->entry_padding += size;
462         }
463
464         /*
465          * "non-sparse" files are really just sparse files with
466          * a single block.
467          */
468         if (tar->sparse_list == NULL)
469                 gnu_add_sparse_entry(tar, 0, tar->entry_bytes_remaining);
470
471         tar->realsize = archive_entry_size(entry);
472
473         if (r == ARCHIVE_OK) {
474                 /*
475                  * "Regular" entry with trailing '/' is really
476                  * directory: This is needed for certain old tar
477                  * variants and even for some broken newer ones.
478                  */
479                 p = archive_entry_pathname(entry);
480                 l = strlen(p);
481                 if (archive_entry_filetype(entry) == AE_IFREG
482                     && p[l-1] == '/')
483                         archive_entry_set_filetype(entry, AE_IFDIR);
484         }
485         return (r);
486 }
487
488 static int
489 archive_read_format_tar_read_data(struct archive_read *a,
490     const void **buff, size_t *size, off_t *offset)
491 {
492         ssize_t bytes_read;
493         struct tar *tar;
494         struct sparse_block *p;
495
496         tar = (struct tar *)(a->format->data);
497
498         if (tar->sparse_gnu_pending) {
499                 if (tar->sparse_gnu_major == 1 && tar->sparse_gnu_minor == 0) {
500                         /*
501                          * <sigh> We should parse the sparse data
502                          * here, but have to parse it as part of the
503                          * header because of a bug in GNU tar 1.16.1.
504                          */
505                 } else {
506                         *size = 0;
507                         *offset = 0;
508                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
509                             "Unrecognized GNU sparse file format");
510                         return (ARCHIVE_WARN);
511                 }
512                 tar->sparse_gnu_pending = 0;
513         }
514
515         /* Remove exhausted entries from sparse list. */
516         while (tar->sparse_list != NULL &&
517             tar->sparse_list->remaining == 0) {
518                 p = tar->sparse_list;
519                 tar->sparse_list = p->next;
520                 free(p);
521         }
522
523         /* If we're at end of file, return EOF. */
524         if (tar->sparse_list == NULL || tar->entry_bytes_remaining == 0) {
525                 if ((a->decompressor->skip)(a, tar->entry_padding) < 0)
526                         return (ARCHIVE_FATAL);
527                 tar->entry_padding = 0;
528                 *buff = NULL;
529                 *size = 0;
530                 *offset = tar->realsize;
531                 return (ARCHIVE_EOF);
532         }
533
534         bytes_read = (a->decompressor->read_ahead)(a, buff, 1);
535         if (bytes_read == 0) {
536                 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
537                     "Truncated tar archive");
538                 return (ARCHIVE_FATAL);
539         }
540         if (bytes_read < 0)
541                 return (ARCHIVE_FATAL);
542         if (bytes_read > tar->entry_bytes_remaining)
543                 bytes_read = tar->entry_bytes_remaining;
544         /* Don't read more than is available in the
545          * current sparse block. */
546         if (tar->sparse_list->remaining < bytes_read)
547                 bytes_read = tar->sparse_list->remaining;
548         *size = bytes_read;
549         *offset = tar->sparse_list->offset;
550         tar->sparse_list->remaining -= bytes_read;
551         tar->sparse_list->offset += bytes_read;
552         tar->entry_bytes_remaining -= bytes_read;
553         (a->decompressor->consume)(a, bytes_read);
554         return (ARCHIVE_OK);
555 }
556
557 static int
558 archive_read_format_tar_skip(struct archive_read *a)
559 {
560         off_t bytes_skipped;
561         struct tar* tar;
562         struct sparse_block *p;
563
564         tar = (struct tar *)(a->format->data);
565
566         /*
567          * Compression layer skip functions are required to either skip the
568          * length requested or fail, so we can rely upon the entire entry
569          * plus padding being skipped.
570          */
571         bytes_skipped = (a->decompressor->skip)(a, tar->entry_bytes_remaining +
572             tar->entry_padding);
573         if (bytes_skipped < 0)
574                 return (ARCHIVE_FATAL);
575
576         tar->entry_bytes_remaining = 0;
577         tar->entry_padding = 0;
578
579         /* Free the sparse list. */
580         while (tar->sparse_list != NULL) {
581                 p = tar->sparse_list;
582                 tar->sparse_list = p->next;
583                 free(p);
584         }
585         tar->sparse_last = NULL;
586
587         return (ARCHIVE_OK);
588 }
589
590 /*
591  * This function recursively interprets all of the headers associated
592  * with a single entry.
593  */
594 static int
595 tar_read_header(struct archive_read *a, struct tar *tar,
596     struct archive_entry *entry)
597 {
598         ssize_t bytes;
599         int err;
600         const void *h;
601         const struct archive_entry_header_ustar *header;
602
603         /* Read 512-byte header record */
604         bytes = (a->decompressor->read_ahead)(a, &h, 512);
605         if (bytes < 512) {
606                 /*
607                  * If we're here, it's becase the _bid function accepted
608                  * this file.  So just call a short read end-of-archive
609                  * and be done with it.
610                  */
611                 return (ARCHIVE_EOF);
612         }
613         (a->decompressor->consume)(a, 512);
614
615         /* Check for end-of-archive mark. */
616         if (((*(const char *)h)==0) && archive_block_is_null((const unsigned char *)h)) {
617                 /* Try to consume a second all-null record, as well. */
618                 bytes = (a->decompressor->read_ahead)(a, &h, 512);
619                 if (bytes > 0)
620                         (a->decompressor->consume)(a, bytes);
621                 archive_set_error(&a->archive, 0, NULL);
622                 return (ARCHIVE_EOF);
623         }
624
625         /*
626          * Note: If the checksum fails and we return ARCHIVE_RETRY,
627          * then the client is likely to just retry.  This is a very
628          * crude way to search for the next valid header!
629          *
630          * TODO: Improve this by implementing a real header scan.
631          */
632         if (!checksum(a, h)) {
633                 archive_set_error(&a->archive, EINVAL, "Damaged tar archive");
634                 return (ARCHIVE_RETRY); /* Retryable: Invalid header */
635         }
636
637         if (++tar->header_recursion_depth > 32) {
638                 archive_set_error(&a->archive, EINVAL, "Too many special headers");
639                 return (ARCHIVE_WARN);
640         }
641
642         /* Determine the format variant. */
643         header = (const struct archive_entry_header_ustar *)h;
644         switch(header->typeflag[0]) {
645         case 'A': /* Solaris tar ACL */
646                 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
647                 a->archive.archive_format_name = "Solaris tar";
648                 err = header_Solaris_ACL(a, tar, entry, h);
649                 break;
650         case 'g': /* POSIX-standard 'g' header. */
651                 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
652                 a->archive.archive_format_name = "POSIX pax interchange format";
653                 err = header_pax_global(a, tar, entry, h);
654                 break;
655         case 'K': /* Long link name (GNU tar, others) */
656                 err = header_longlink(a, tar, entry, h);
657                 break;
658         case 'L': /* Long filename (GNU tar, others) */
659                 err = header_longname(a, tar, entry, h);
660                 break;
661         case 'V': /* GNU volume header */
662                 err = header_volume(a, tar, entry, h);
663                 break;
664         case 'X': /* Used by SUN tar; same as 'x'. */
665                 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
666                 a->archive.archive_format_name =
667                     "POSIX pax interchange format (Sun variant)";
668                 err = header_pax_extensions(a, tar, entry, h);
669                 break;
670         case 'x': /* POSIX-standard 'x' header. */
671                 a->archive.archive_format = ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE;
672                 a->archive.archive_format_name = "POSIX pax interchange format";
673                 err = header_pax_extensions(a, tar, entry, h);
674                 break;
675         default:
676                 if (memcmp(header->magic, "ustar  \0", 8) == 0) {
677                         a->archive.archive_format = ARCHIVE_FORMAT_TAR_GNUTAR;
678                         a->archive.archive_format_name = "GNU tar format";
679                         err = header_gnutar(a, tar, entry, h);
680                 } else if (memcmp(header->magic, "ustar", 5) == 0) {
681                         if (a->archive.archive_format != ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE) {
682                                 a->archive.archive_format = ARCHIVE_FORMAT_TAR_USTAR;
683                                 a->archive.archive_format_name = "POSIX ustar format";
684                         }
685                         err = header_ustar(a, tar, entry, h);
686                 } else {
687                         a->archive.archive_format = ARCHIVE_FORMAT_TAR;
688                         a->archive.archive_format_name = "tar (non-POSIX)";
689                         err = header_old_tar(a, tar, entry, h);
690                 }
691         }
692         --tar->header_recursion_depth;
693         /* We return warnings or success as-is.  Anything else is fatal. */
694         if (err == ARCHIVE_WARN || err == ARCHIVE_OK)
695                 return (err);
696         if (err == ARCHIVE_EOF)
697                 /* EOF when recursively reading a header is bad. */
698                 archive_set_error(&a->archive, EINVAL, "Damaged tar archive");
699         return (ARCHIVE_FATAL);
700 }
701
702 /*
703  * Return true if block checksum is correct.
704  */
705 static int
706 checksum(struct archive_read *a, const void *h)
707 {
708         const unsigned char *bytes;
709         const struct archive_entry_header_ustar *header;
710         int check, i, sum;
711
712         (void)a; /* UNUSED */
713         bytes = (const unsigned char *)h;
714         header = (const struct archive_entry_header_ustar *)h;
715
716         /*
717          * Test the checksum.  Note that POSIX specifies _unsigned_
718          * bytes for this calculation.
719          */
720         sum = tar_atol(header->checksum, sizeof(header->checksum));
721         check = 0;
722         for (i = 0; i < 148; i++)
723                 check += (unsigned char)bytes[i];
724         for (; i < 156; i++)
725                 check += 32;
726         for (; i < 512; i++)
727                 check += (unsigned char)bytes[i];
728         if (sum == check)
729                 return (1);
730
731         /*
732          * Repeat test with _signed_ bytes, just in case this archive
733          * was created by an old BSD, Solaris, or HP-UX tar with a
734          * broken checksum calculation.
735          */
736         check = 0;
737         for (i = 0; i < 148; i++)
738                 check += (signed char)bytes[i];
739         for (; i < 156; i++)
740                 check += 32;
741         for (; i < 512; i++)
742                 check += (signed char)bytes[i];
743         if (sum == check)
744                 return (1);
745
746         return (0);
747 }
748
749 /*
750  * Return true if this block contains only nulls.
751  */
752 static int
753 archive_block_is_null(const unsigned char *p)
754 {
755         unsigned i;
756
757         for (i = 0; i < ARCHIVE_BYTES_PER_RECORD / sizeof(*p); i++)
758                 if (*p++)
759                         return (0);
760         return (1);
761 }
762
763 /*
764  * Interpret 'A' Solaris ACL header
765  */
766 static int
767 header_Solaris_ACL(struct archive_read *a, struct tar *tar,
768     struct archive_entry *entry, const void *h)
769 {
770         const struct archive_entry_header_ustar *header;
771         size_t size;
772         int err;
773         char *acl, *p;
774         wchar_t *wp;
775
776         /*
777          * read_body_to_string adds a NUL terminator, but we need a little
778          * more to make sure that we don't overrun acl_text later.
779          */
780         header = (const struct archive_entry_header_ustar *)h;
781         size = tar_atol(header->size, sizeof(header->size));
782         err = read_body_to_string(a, tar, &(tar->acl_text), h);
783         if (err != ARCHIVE_OK)
784                 return (err);
785         err = tar_read_header(a, tar, entry);
786         if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
787                 return (err);
788
789         /* Skip leading octal number. */
790         /* XXX TODO: Parse the octal number and sanity-check it. */
791         p = acl = tar->acl_text.s;
792         while (*p != '\0' && p < acl + size)
793                 p++;
794         p++;
795
796         if (p >= acl + size) {
797                 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
798                     "Malformed Solaris ACL attribute");
799                 return(ARCHIVE_WARN);
800         }
801
802         /* Skip leading octal number. */
803         size -= (p - acl);
804         acl = p;
805
806         while (*p != '\0' && p < acl + size)
807                 p++;
808
809         wp = (wchar_t *)malloc((p - acl + 1) * sizeof(wchar_t));
810         if (wp == NULL) {
811                 archive_set_error(&a->archive, ENOMEM,
812                     "Can't allocate work buffer for ACL parsing");
813                 return (ARCHIVE_FATAL);
814         }
815         utf8_decode(wp, acl, p - acl);
816         err = __archive_entry_acl_parse_w(entry, wp,
817             ARCHIVE_ENTRY_ACL_TYPE_ACCESS);
818         free(wp);
819         return (err);
820 }
821
822 /*
823  * Interpret 'K' long linkname header.
824  */
825 static int
826 header_longlink(struct archive_read *a, struct tar *tar,
827     struct archive_entry *entry, const void *h)
828 {
829         int err;
830
831         err = read_body_to_string(a, tar, &(tar->longlink), h);
832         if (err != ARCHIVE_OK)
833                 return (err);
834         err = tar_read_header(a, tar, entry);
835         if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
836                 return (err);
837         /* Set symlink if symlink already set, else hardlink. */
838         archive_entry_set_link(entry, tar->longlink.s);
839         return (ARCHIVE_OK);
840 }
841
842 /*
843  * Interpret 'L' long filename header.
844  */
845 static int
846 header_longname(struct archive_read *a, struct tar *tar,
847     struct archive_entry *entry, const void *h)
848 {
849         int err;
850
851         err = read_body_to_string(a, tar, &(tar->longname), h);
852         if (err != ARCHIVE_OK)
853                 return (err);
854         /* Read and parse "real" header, then override name. */
855         err = tar_read_header(a, tar, entry);
856         if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
857                 return (err);
858         archive_entry_set_pathname(entry, tar->longname.s);
859         return (ARCHIVE_OK);
860 }
861
862
863 /*
864  * Interpret 'V' GNU tar volume header.
865  */
866 static int
867 header_volume(struct archive_read *a, struct tar *tar,
868     struct archive_entry *entry, const void *h)
869 {
870         (void)h;
871
872         /* Just skip this and read the next header. */
873         return (tar_read_header(a, tar, entry));
874 }
875
876 /*
877  * Read body of an archive entry into an archive_string object.
878  */
879 static int
880 read_body_to_string(struct archive_read *a, struct tar *tar,
881     struct archive_string *as, const void *h)
882 {
883         off_t size, padded_size;
884         ssize_t bytes_read, bytes_to_copy;
885         const struct archive_entry_header_ustar *header;
886         const void *src;
887         char *dest;
888
889         (void)tar; /* UNUSED */
890         header = (const struct archive_entry_header_ustar *)h;
891         size  = tar_atol(header->size, sizeof(header->size));
892         if ((size > 1048576) || (size < 0)) {
893                 archive_set_error(&a->archive, EINVAL,
894                     "Special header too large");
895                 return (ARCHIVE_FATAL);
896         }
897
898         /* Read the body into the string. */
899         archive_string_ensure(as, size+1);
900         padded_size = (size + 511) & ~ 511;
901         dest = as->s;
902         while (padded_size > 0) {
903                 bytes_read = (a->decompressor->read_ahead)(a, &src, padded_size);
904                 if (bytes_read == 0)
905                         return (ARCHIVE_EOF);
906                 if (bytes_read < 0)
907                         return (ARCHIVE_FATAL);
908                 if (bytes_read > padded_size)
909                         bytes_read = padded_size;
910                 (a->decompressor->consume)(a, bytes_read);
911                 bytes_to_copy = bytes_read;
912                 if ((off_t)bytes_to_copy > size)
913                         bytes_to_copy = (ssize_t)size;
914                 memcpy(dest, src, bytes_to_copy);
915                 dest += bytes_to_copy;
916                 size -= bytes_to_copy;
917                 padded_size -= bytes_read;
918         }
919         *dest = '\0';
920         return (ARCHIVE_OK);
921 }
922
923 /*
924  * Parse out common header elements.
925  *
926  * This would be the same as header_old_tar, except that the
927  * filename is handled slightly differently for old and POSIX
928  * entries  (POSIX entries support a 'prefix').  This factoring
929  * allows header_old_tar and header_ustar
930  * to handle filenames differently, while still putting most of the
931  * common parsing into one place.
932  */
933 static int
934 header_common(struct archive_read *a, struct tar *tar,
935     struct archive_entry *entry, const void *h)
936 {
937         const struct archive_entry_header_ustar *header;
938         char    tartype;
939
940         (void)a; /* UNUSED */
941
942         header = (const struct archive_entry_header_ustar *)h;
943         if (header->linkname[0])
944                 archive_strncpy(&(tar->entry_linkname), header->linkname,
945                     sizeof(header->linkname));
946         else
947                 archive_string_empty(&(tar->entry_linkname));
948
949         /* Parse out the numeric fields (all are octal) */
950         archive_entry_set_mode(entry, tar_atol(header->mode, sizeof(header->mode)));
951         archive_entry_set_uid(entry, tar_atol(header->uid, sizeof(header->uid)));
952         archive_entry_set_gid(entry, tar_atol(header->gid, sizeof(header->gid)));
953         tar->entry_bytes_remaining = tar_atol(header->size, sizeof(header->size));
954         archive_entry_set_size(entry, tar->entry_bytes_remaining);
955         archive_entry_set_mtime(entry, tar_atol(header->mtime, sizeof(header->mtime)), 0);
956
957         /* Handle the tar type flag appropriately. */
958         tartype = header->typeflag[0];
959
960         switch (tartype) {
961         case '1': /* Hard link */
962                 archive_entry_set_hardlink(entry, tar->entry_linkname.s);
963                 /*
964                  * The following may seem odd, but: Technically, tar
965                  * does not store the file type for a "hard link"
966                  * entry, only the fact that it is a hard link.  So, I
967                  * leave the type zero normally.  But, pax interchange
968                  * format allows hard links to have data, which
969                  * implies that the underlying entry is a regular
970                  * file.
971                  */
972                 if (archive_entry_size(entry) > 0)
973                         archive_entry_set_filetype(entry, AE_IFREG);
974
975                 /*
976                  * A tricky point: Traditionally, tar readers have
977                  * ignored the size field when reading hardlink
978                  * entries, and some writers put non-zero sizes even
979                  * though the body is empty.  POSIX.1-2001 broke with
980                  * this tradition by permitting hardlink entries to
981                  * store valid bodies in pax interchange format, but
982                  * not in ustar format.  Since there is no hard and
983                  * fast way to distinguish pax interchange from
984                  * earlier archives (the 'x' and 'g' entries are
985                  * optional, after all), we need a heuristic.  Here, I
986                  * use the bid function to test whether or not there's
987                  * a valid header following.  Of course, if we know
988                  * this is pax interchange format, then we must obey
989                  * the size.
990                  *
991                  * This heuristic will only fail for a pax interchange
992                  * archive that is storing hardlink bodies, no pax
993                  * extended attribute entries have yet occurred, and
994                  * we encounter a hardlink entry for a file that is
995                  * itself an uncompressed tar archive.
996                  */
997                 if (archive_entry_size(entry) > 0  &&
998                     a->archive.archive_format != ARCHIVE_FORMAT_TAR_PAX_INTERCHANGE  &&
999                     archive_read_format_tar_bid(a) > 50) {
1000                         archive_entry_set_size(entry, 0);
1001                         tar->entry_bytes_remaining = 0;
1002                 }
1003         case '2': /* Symlink */
1004                 archive_entry_set_filetype(entry, AE_IFLNK);
1005                 archive_entry_set_size(entry, 0);
1006                 tar->entry_bytes_remaining = 0;
1007                 archive_entry_set_symlink(entry, tar->entry_linkname.s);
1008                 break;
1009         case '3': /* Character device */
1010                 archive_entry_set_filetype(entry, AE_IFCHR);
1011                 archive_entry_set_size(entry, 0);
1012                 tar->entry_bytes_remaining = 0;
1013                 break;
1014         case '4': /* Block device */
1015                 archive_entry_set_filetype(entry, AE_IFBLK);
1016                 archive_entry_set_size(entry, 0);
1017                 tar->entry_bytes_remaining = 0;
1018                 break;
1019         case '5': /* Dir */
1020                 archive_entry_set_filetype(entry, AE_IFDIR);
1021                 archive_entry_set_size(entry, 0);
1022                 tar->entry_bytes_remaining = 0;
1023                 break;
1024         case '6': /* FIFO device */
1025                 archive_entry_set_filetype(entry, AE_IFIFO);
1026                 archive_entry_set_size(entry, 0);
1027                 tar->entry_bytes_remaining = 0;
1028                 break;
1029         case 'D': /* GNU incremental directory type */
1030                 /*
1031                  * No special handling is actually required here.
1032                  * It might be nice someday to preprocess the file list and
1033                  * provide it to the client, though.
1034                  */
1035                 archive_entry_set_filetype(entry, AE_IFDIR);
1036                 break;
1037         case 'M': /* GNU "Multi-volume" (remainder of file from last archive)*/
1038                 /*
1039                  * As far as I can tell, this is just like a regular file
1040                  * entry, except that the contents should be _appended_ to
1041                  * the indicated file at the indicated offset.  This may
1042                  * require some API work to fully support.
1043                  */
1044                 break;
1045         case 'N': /* Old GNU "long filename" entry. */
1046                 /* The body of this entry is a script for renaming
1047                  * previously-extracted entries.  Ugh.  It will never
1048                  * be supported by libarchive. */
1049                 archive_entry_set_filetype(entry, AE_IFREG);
1050                 break;
1051         case 'S': /* GNU sparse files */
1052                 /*
1053                  * Sparse files are really just regular files with
1054                  * sparse information in the extended area.
1055                  */
1056                 /* FALLTHROUGH */
1057         default: /* Regular file  and non-standard types */
1058                 /*
1059                  * Per POSIX: non-recognized types should always be
1060                  * treated as regular files.
1061                  */
1062                 archive_entry_set_filetype(entry, AE_IFREG);
1063                 break;
1064         }
1065         return (0);
1066 }
1067
1068 /*
1069  * Parse out header elements for "old-style" tar archives.
1070  */
1071 static int
1072 header_old_tar(struct archive_read *a, struct tar *tar,
1073     struct archive_entry *entry, const void *h)
1074 {
1075         const struct archive_entry_header_ustar *header;
1076
1077         /* Copy filename over (to ensure null termination). */
1078         header = (const struct archive_entry_header_ustar *)h;
1079         archive_strncpy(&(tar->entry_name), header->name, sizeof(header->name));
1080         archive_entry_set_pathname(entry, tar->entry_name.s);
1081
1082         /* Grab rest of common fields */
1083         header_common(a, tar, entry, h);
1084
1085         tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1086         return (0);
1087 }
1088
1089 /*
1090  * Parse a file header for a pax extended archive entry.
1091  */
1092 static int
1093 header_pax_global(struct archive_read *a, struct tar *tar,
1094     struct archive_entry *entry, const void *h)
1095 {
1096         int err;
1097
1098         err = read_body_to_string(a, tar, &(tar->pax_global), h);
1099         if (err != ARCHIVE_OK)
1100                 return (err);
1101         err = tar_read_header(a, tar, entry);
1102         return (err);
1103 }
1104
1105 static int
1106 header_pax_extensions(struct archive_read *a, struct tar *tar,
1107     struct archive_entry *entry, const void *h)
1108 {
1109         int err, err2;
1110
1111         err = read_body_to_string(a, tar, &(tar->pax_header), h);
1112         if (err != ARCHIVE_OK)
1113                 return (err);
1114
1115         /* Parse the next header. */
1116         err = tar_read_header(a, tar, entry);
1117         if ((err != ARCHIVE_OK) && (err != ARCHIVE_WARN))
1118                 return (err);
1119
1120         /*
1121          * TODO: Parse global/default options into 'entry' struct here
1122          * before handling file-specific options.
1123          *
1124          * This design (parse standard header, then overwrite with pax
1125          * extended attribute data) usually works well, but isn't ideal;
1126          * it would be better to parse the pax extended attributes first
1127          * and then skip any fields in the standard header that were
1128          * defined in the pax header.
1129          */
1130         err2 = pax_header(a, tar, entry, tar->pax_header.s);
1131         err =  err_combine(err, err2);
1132         tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1133         return (err);
1134 }
1135
1136
1137 /*
1138  * Parse a file header for a Posix "ustar" archive entry.  This also
1139  * handles "pax" or "extended ustar" entries.
1140  */
1141 static int
1142 header_ustar(struct archive_read *a, struct tar *tar,
1143     struct archive_entry *entry, const void *h)
1144 {
1145         const struct archive_entry_header_ustar *header;
1146         struct archive_string *as;
1147
1148         header = (const struct archive_entry_header_ustar *)h;
1149
1150         /* Copy name into an internal buffer to ensure null-termination. */
1151         as = &(tar->entry_name);
1152         if (header->prefix[0]) {
1153                 archive_strncpy(as, header->prefix, sizeof(header->prefix));
1154                 if (as->s[archive_strlen(as) - 1] != '/')
1155                         archive_strappend_char(as, '/');
1156                 archive_strncat(as, header->name, sizeof(header->name));
1157         } else
1158                 archive_strncpy(as, header->name, sizeof(header->name));
1159
1160         archive_entry_set_pathname(entry, as->s);
1161
1162         /* Handle rest of common fields. */
1163         header_common(a, tar, entry, h);
1164
1165         /* Handle POSIX ustar fields. */
1166         archive_strncpy(&(tar->entry_uname), header->uname,
1167             sizeof(header->uname));
1168         archive_entry_set_uname(entry, tar->entry_uname.s);
1169
1170         archive_strncpy(&(tar->entry_gname), header->gname,
1171             sizeof(header->gname));
1172         archive_entry_set_gname(entry, tar->entry_gname.s);
1173
1174         /* Parse out device numbers only for char and block specials. */
1175         if (header->typeflag[0] == '3' || header->typeflag[0] == '4') {
1176                 archive_entry_set_rdevmajor(entry,
1177                     tar_atol(header->rdevmajor, sizeof(header->rdevmajor)));
1178                 archive_entry_set_rdevminor(entry,
1179                     tar_atol(header->rdevminor, sizeof(header->rdevminor)));
1180         }
1181
1182         tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1183
1184         return (0);
1185 }
1186
1187
1188 /*
1189  * Parse the pax extended attributes record.
1190  *
1191  * Returns non-zero if there's an error in the data.
1192  */
1193 static int
1194 pax_header(struct archive_read *a, struct tar *tar,
1195     struct archive_entry *entry, char *attr)
1196 {
1197         size_t attr_length, l, line_length;
1198         char *line, *p;
1199         wchar_t *key, *wp, *value;
1200         int err, err2;
1201
1202         attr_length = strlen(attr);
1203         err = ARCHIVE_OK;
1204         while (attr_length > 0) {
1205                 /* Parse decimal length field at start of line. */
1206                 line_length = 0;
1207                 l = attr_length;
1208                 line = p = attr; /* Record start of line. */
1209                 while (l>0) {
1210                         if (*p == ' ') {
1211                                 p++;
1212                                 l--;
1213                                 break;
1214                         }
1215                         if (*p < '0' || *p > '9') {
1216                                 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1217                                     "Ignoring malformed pax extended attributes");
1218                                 return (ARCHIVE_WARN);
1219                         }
1220                         line_length *= 10;
1221                         line_length += *p - '0';
1222                         if (line_length > 999999) {
1223                                 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1224                                     "Rejecting pax extended attribute > 1MB");
1225                                 return (ARCHIVE_WARN);
1226                         }
1227                         p++;
1228                         l--;
1229                 }
1230
1231                 /*
1232                  * Parsed length must be no bigger than available data,
1233                  * at least 1, and the last character of the line must
1234                  * be '\n'.
1235                  */
1236                 if (line_length > attr_length
1237                     || line_length < 1
1238                     || attr[line_length - 1] != '\n')
1239                 {
1240                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1241                             "Ignoring malformed pax extended attribute");
1242                         return (ARCHIVE_WARN);
1243                 }
1244
1245                 /* Ensure pax_entry buffer is big enough. */
1246                 if (tar->pax_entry_length <= line_length) {
1247                         wchar_t *old_entry = tar->pax_entry;
1248
1249                         if (tar->pax_entry_length <= 0)
1250                                 tar->pax_entry_length = 1024;
1251                         while (tar->pax_entry_length <= line_length + 1)
1252                                 tar->pax_entry_length *= 2;
1253
1254                         old_entry = tar->pax_entry;
1255                         tar->pax_entry = (wchar_t *)realloc(tar->pax_entry,
1256                             tar->pax_entry_length * sizeof(wchar_t));
1257                         if (tar->pax_entry == NULL) {
1258                                 free(old_entry);
1259                                 archive_set_error(&a->archive, ENOMEM,
1260                                         "No memory");
1261                                 return (ARCHIVE_FATAL);
1262                         }
1263                 }
1264
1265                 /* Decode UTF-8 to wchar_t, null-terminate result. */
1266                 if (utf8_decode(tar->pax_entry, p,
1267                         line_length - (p - attr) - 1)) {
1268                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1269                            "Invalid UTF8 character in pax extended attribute");
1270                         err = err_combine(err, ARCHIVE_WARN);
1271                 }
1272
1273                 /* Null-terminate 'key' value. */
1274                 wp = key = tar->pax_entry;
1275                 if (key[0] == L'=')
1276                         return (-1);
1277                 while (*wp && *wp != L'=')
1278                         ++wp;
1279                 if (*wp == L'\0') {
1280                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1281                             "Invalid pax extended attributes");
1282                         return (ARCHIVE_WARN);
1283                 }
1284                 *wp = 0;
1285
1286                 /* Identify null-terminated 'value' portion. */
1287                 value = wp + 1;
1288
1289                 /* Identify this attribute and set it in the entry. */
1290                 err2 = pax_attribute(tar, entry, key, value);
1291                 err = err_combine(err, err2);
1292
1293                 /* Skip to next line */
1294                 attr += line_length;
1295                 attr_length -= line_length;
1296         }
1297         return (err);
1298 }
1299
1300 static int
1301 pax_attribute_xattr(struct archive_entry *entry,
1302         wchar_t *name, wchar_t *value)
1303 {
1304         char *name_decoded, *name_narrow;
1305         void *value_decoded;
1306         size_t value_len;
1307
1308         if (wcslen(name) < 18 || (wcsncmp(name, L"LIBARCHIVE.xattr.", 17)) != 0)
1309                 return 3;
1310
1311         name += 17;
1312
1313         /* URL-decode name */
1314         name_narrow = wide_to_narrow(name);
1315         if (name_narrow == NULL)
1316                 return 2;
1317         name_decoded = url_decode(name_narrow);
1318         free(name_narrow);
1319         if (name_decoded == NULL)
1320                 return 2;
1321
1322         /* Base-64 decode value */
1323         value_decoded = base64_decode(value, wcslen(value), &value_len);
1324         if (value_decoded == NULL) {
1325                 free(name_decoded);
1326                 return 1;
1327         }
1328
1329         archive_entry_xattr_add_entry(entry, name_decoded,
1330                 value_decoded, value_len);
1331
1332         free(name_decoded);
1333         free(value_decoded);
1334         return 0;
1335 }
1336
1337 /*
1338  * Parse a single key=value attribute.  key/value pointers are
1339  * assumed to point into reasonably long-lived storage.
1340  *
1341  * Note that POSIX reserves all-lowercase keywords.  Vendor-specific
1342  * extensions should always have keywords of the form "VENDOR.attribute"
1343  * In particular, it's quite feasible to support many different
1344  * vendor extensions here.  I'm using "LIBARCHIVE" for extensions
1345  * unique to this library.
1346  *
1347  * Investigate other vendor-specific extensions and see if
1348  * any of them look useful.
1349  */
1350 static int
1351 pax_attribute(struct tar *tar, struct archive_entry *entry,
1352     wchar_t *key, wchar_t *value)
1353 {
1354         int64_t s;
1355         long n;
1356
1357         switch (key[0]) {
1358         case 'G':
1359                 /* GNU "0.0" sparse pax format. */
1360                 if (wcscmp(key, L"GNU.sparse.numblocks") == 0) {
1361                         tar->sparse_offset = -1;
1362                         tar->sparse_numbytes = -1;
1363                         tar->sparse_gnu_major = 0;
1364                         tar->sparse_gnu_minor = 0;
1365                 }
1366                 if (wcscmp(key, L"GNU.sparse.offset") == 0) {
1367                         tar->sparse_offset = tar_atol10(value, wcslen(value));
1368                         if (tar->sparse_numbytes != -1) {
1369                                 gnu_add_sparse_entry(tar,
1370                                     tar->sparse_offset, tar->sparse_numbytes);
1371                                 tar->sparse_offset = -1;
1372                                 tar->sparse_numbytes = -1;
1373                         }
1374                 }
1375                 if (wcscmp(key, L"GNU.sparse.numbytes") == 0) {
1376                         tar->sparse_numbytes = tar_atol10(value, wcslen(value));
1377                         if (tar->sparse_numbytes != -1) {
1378                                 gnu_add_sparse_entry(tar,
1379                                     tar->sparse_offset, tar->sparse_numbytes);
1380                                 tar->sparse_offset = -1;
1381                                 tar->sparse_numbytes = -1;
1382                         }
1383                 }
1384                 if (wcscmp(key, L"GNU.sparse.size") == 0)
1385                         archive_entry_set_size(entry,
1386                             tar_atol10(value, wcslen(value)));
1387
1388                 /* GNU "0.1" sparse pax format. */
1389                 if (wcscmp(key, L"GNU.sparse.map") == 0) {
1390                         tar->sparse_gnu_major = 0;
1391                         tar->sparse_gnu_minor = 1;
1392                         if (gnu_sparse_01_parse(tar, value) != ARCHIVE_OK)
1393                                 return (ARCHIVE_WARN);
1394                 }
1395
1396                 /* GNU "1.0" sparse pax format */
1397                 if (wcscmp(key, L"GNU.sparse.major") == 0) {
1398                         tar->sparse_gnu_major = tar_atol10(value, wcslen(value));
1399                         tar->sparse_gnu_pending = 1;
1400                 }
1401                 if (wcscmp(key, L"GNU.sparse.minor") == 0) {
1402                         tar->sparse_gnu_minor = tar_atol10(value, wcslen(value));
1403                         tar->sparse_gnu_pending = 1;
1404                 }
1405                 if (wcscmp(key, L"GNU.sparse.name") == 0)
1406                         archive_entry_copy_pathname_w(entry, value);
1407                 if (wcscmp(key, L"GNU.sparse.realsize") == 0)
1408                         archive_entry_set_size(entry,
1409                             tar_atol10(value, wcslen(value)));
1410                 break;
1411         case 'L':
1412                 /* Our extensions */
1413 /* TODO: Handle arbitrary extended attributes... */
1414 /*
1415                 if (strcmp(key, "LIBARCHIVE.xxxxxxx")==0)
1416                         archive_entry_set_xxxxxx(entry, value);
1417 */
1418                 if (wcsncmp(key, L"LIBARCHIVE.xattr.", 17)==0)
1419                         pax_attribute_xattr(entry, key, value);
1420                 break;
1421         case 'S':
1422                 /* We support some keys used by the "star" archiver */
1423                 if (wcscmp(key, L"SCHILY.acl.access")==0)
1424                         __archive_entry_acl_parse_w(entry, value,
1425                             ARCHIVE_ENTRY_ACL_TYPE_ACCESS);
1426                 else if (wcscmp(key, L"SCHILY.acl.default")==0)
1427                         __archive_entry_acl_parse_w(entry, value,
1428                             ARCHIVE_ENTRY_ACL_TYPE_DEFAULT);
1429                 else if (wcscmp(key, L"SCHILY.devmajor")==0)
1430                         archive_entry_set_rdevmajor(entry, tar_atol10(value, wcslen(value)));
1431                 else if (wcscmp(key, L"SCHILY.devminor")==0)
1432                         archive_entry_set_rdevminor(entry, tar_atol10(value, wcslen(value)));
1433                 else if (wcscmp(key, L"SCHILY.fflags")==0)
1434                         archive_entry_copy_fflags_text_w(entry, value);
1435                 else if (wcscmp(key, L"SCHILY.dev")==0)
1436                         archive_entry_set_dev(entry, tar_atol10(value, wcslen(value)));
1437                 else if (wcscmp(key, L"SCHILY.ino")==0)
1438                         archive_entry_set_ino(entry, tar_atol10(value, wcslen(value)));
1439                 else if (wcscmp(key, L"SCHILY.nlink")==0)
1440                         archive_entry_set_nlink(entry, tar_atol10(value, wcslen(value)));
1441                 break;
1442         case 'a':
1443                 if (wcscmp(key, L"atime")==0) {
1444                         pax_time(value, &s, &n);
1445                         archive_entry_set_atime(entry, s, n);
1446                 }
1447                 break;
1448         case 'c':
1449                 if (wcscmp(key, L"ctime")==0) {
1450                         pax_time(value, &s, &n);
1451                         archive_entry_set_ctime(entry, s, n);
1452                 } else if (wcscmp(key, L"charset")==0) {
1453                         /* TODO: Publish charset information in entry. */
1454                 } else if (wcscmp(key, L"comment")==0) {
1455                         /* TODO: Publish comment in entry. */
1456                 }
1457                 break;
1458         case 'g':
1459                 if (wcscmp(key, L"gid")==0)
1460                         archive_entry_set_gid(entry, tar_atol10(value, wcslen(value)));
1461                 else if (wcscmp(key, L"gname")==0)
1462                         archive_entry_copy_gname_w(entry, value);
1463                 break;
1464         case 'l':
1465                 /* pax interchange doesn't distinguish hardlink vs. symlink. */
1466                 if (wcscmp(key, L"linkpath")==0) {
1467                         if (archive_entry_hardlink(entry))
1468                                 archive_entry_copy_hardlink_w(entry, value);
1469                         else
1470                                 archive_entry_copy_symlink_w(entry, value);
1471                 }
1472                 break;
1473         case 'm':
1474                 if (wcscmp(key, L"mtime")==0) {
1475                         pax_time(value, &s, &n);
1476                         archive_entry_set_mtime(entry, s, n);
1477                 }
1478                 break;
1479         case 'p':
1480                 if (wcscmp(key, L"path")==0)
1481                         archive_entry_copy_pathname_w(entry, value);
1482                 break;
1483         case 'r':
1484                 /* POSIX has reserved 'realtime.*' */
1485                 break;
1486         case 's':
1487                 /* POSIX has reserved 'security.*' */
1488                 /* Someday: if (wcscmp(key, L"security.acl")==0) { ... } */
1489                 if (wcscmp(key, L"size")==0) {
1490                         tar->entry_bytes_remaining = tar_atol10(value, wcslen(value));
1491                         archive_entry_set_size(entry, tar->entry_bytes_remaining);
1492                 }
1493                 tar->entry_bytes_remaining = 0;
1494
1495                 break;
1496         case 'u':
1497                 if (wcscmp(key, L"uid")==0)
1498                         archive_entry_set_uid(entry, tar_atol10(value, wcslen(value)));
1499                 else if (wcscmp(key, L"uname")==0)
1500                         archive_entry_copy_uname_w(entry, value);
1501                 break;
1502         }
1503         return (0);
1504 }
1505
1506
1507
1508 /*
1509  * parse a decimal time value, which may include a fractional portion
1510  */
1511 static void
1512 pax_time(const wchar_t *p, int64_t *ps, long *pn)
1513 {
1514         char digit;
1515         int64_t s;
1516         unsigned long l;
1517         int sign;
1518         int64_t limit, last_digit_limit;
1519
1520         limit = INT64_MAX / 10;
1521         last_digit_limit = INT64_MAX % 10;
1522
1523         s = 0;
1524         sign = 1;
1525         if (*p == '-') {
1526                 sign = -1;
1527                 p++;
1528         }
1529         while (*p >= '0' && *p <= '9') {
1530                 digit = *p - '0';
1531                 if (s > limit ||
1532                     (s == limit && digit > last_digit_limit)) {
1533                         s = UINT64_MAX;
1534                         break;
1535                 }
1536                 s = (s * 10) + digit;
1537                 ++p;
1538         }
1539
1540         *ps = s * sign;
1541
1542         /* Calculate nanoseconds. */
1543         *pn = 0;
1544
1545         if (*p != '.')
1546                 return;
1547
1548         l = 100000000UL;
1549         do {
1550                 ++p;
1551                 if (*p >= '0' && *p <= '9')
1552                         *pn += (*p - '0') * l;
1553                 else
1554                         break;
1555         } while (l /= 10);
1556 }
1557
1558 /*
1559  * Parse GNU tar header
1560  */
1561 static int
1562 header_gnutar(struct archive_read *a, struct tar *tar,
1563     struct archive_entry *entry, const void *h)
1564 {
1565         const struct archive_entry_header_gnutar *header;
1566
1567         (void)a;
1568
1569         /*
1570          * GNU header is like POSIX ustar, except 'prefix' is
1571          * replaced with some other fields. This also means the
1572          * filename is stored as in old-style archives.
1573          */
1574
1575         /* Grab fields common to all tar variants. */
1576         header_common(a, tar, entry, h);
1577
1578         /* Copy filename over (to ensure null termination). */
1579         header = (const struct archive_entry_header_gnutar *)h;
1580         archive_strncpy(&(tar->entry_name), header->name,
1581             sizeof(header->name));
1582         archive_entry_set_pathname(entry, tar->entry_name.s);
1583
1584         /* Fields common to ustar and GNU */
1585         /* XXX Can the following be factored out since it's common
1586          * to ustar and gnu tar?  Is it okay to move it down into
1587          * header_common, perhaps?  */
1588         archive_strncpy(&(tar->entry_uname),
1589             header->uname, sizeof(header->uname));
1590         archive_entry_set_uname(entry, tar->entry_uname.s);
1591
1592         archive_strncpy(&(tar->entry_gname),
1593             header->gname, sizeof(header->gname));
1594         archive_entry_set_gname(entry, tar->entry_gname.s);
1595
1596         /* Parse out device numbers only for char and block specials */
1597         if (header->typeflag[0] == '3' || header->typeflag[0] == '4') {
1598                 archive_entry_set_rdevmajor(entry,
1599                     tar_atol(header->rdevmajor, sizeof(header->rdevmajor)));
1600                 archive_entry_set_rdevminor(entry,
1601                     tar_atol(header->rdevminor, sizeof(header->rdevminor)));
1602         } else
1603                 archive_entry_set_rdev(entry, 0);
1604
1605         tar->entry_padding = 0x1ff & (-tar->entry_bytes_remaining);
1606
1607         /* Grab GNU-specific fields. */
1608         archive_entry_set_atime(entry,
1609             tar_atol(header->atime, sizeof(header->atime)), 0);
1610         archive_entry_set_ctime(entry,
1611             tar_atol(header->ctime, sizeof(header->ctime)), 0);
1612         if (header->realsize[0] != 0) {
1613                 archive_entry_set_size(entry,
1614                     tar_atol(header->realsize, sizeof(header->realsize)));
1615         }
1616
1617         if (header->sparse[0].offset[0] != 0) {
1618                 gnu_sparse_old_read(a, tar, header);
1619         } else {
1620                 if (header->isextended[0] != 0) {
1621                         /* XXX WTF? XXX */
1622                 }
1623         }
1624
1625         return (0);
1626 }
1627
1628 static void
1629 gnu_add_sparse_entry(struct tar *tar, off_t offset, off_t remaining)
1630 {
1631         struct sparse_block *p;
1632
1633         p = (struct sparse_block *)malloc(sizeof(*p));
1634         if (p == NULL)
1635                 __archive_errx(1, "Out of memory");
1636         memset(p, 0, sizeof(*p));
1637         if (tar->sparse_last != NULL)
1638                 tar->sparse_last->next = p;
1639         else
1640                 tar->sparse_list = p;
1641         tar->sparse_last = p;
1642         p->offset = offset;
1643         p->remaining = remaining;
1644 }
1645
1646 /*
1647  * GNU tar old-format sparse data.
1648  *
1649  * GNU old-format sparse data is stored in a fixed-field
1650  * format.  Offset/size values are 11-byte octal fields (same
1651  * format as 'size' field in ustart header).  These are
1652  * stored in the header, allocating subsequent header blocks
1653  * as needed.  Extending the header in this way is a pretty
1654  * severe POSIX violation; this design has earned GNU tar a
1655  * lot of criticism.
1656  */
1657
1658 static int
1659 gnu_sparse_old_read(struct archive_read *a, struct tar *tar,
1660     const struct archive_entry_header_gnutar *header)
1661 {
1662         ssize_t bytes_read;
1663         const void *data;
1664         struct extended {
1665                 struct gnu_sparse sparse[21];
1666                 char    isextended[1];
1667                 char    padding[7];
1668         };
1669         const struct extended *ext;
1670
1671         gnu_sparse_old_parse(tar, header->sparse, 4);
1672         if (header->isextended[0] == 0)
1673                 return (ARCHIVE_OK);
1674
1675         do {
1676                 bytes_read = (a->decompressor->read_ahead)(a, &data, 512);
1677                 if (bytes_read < 0)
1678                         return (ARCHIVE_FATAL);
1679                 if (bytes_read < 512) {
1680                         archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
1681                             "Truncated tar archive "
1682                             "detected while reading sparse file data");
1683                         return (ARCHIVE_FATAL);
1684                 }
1685                 (a->decompressor->consume)(a, 512);
1686                 ext = (const struct extended *)data;
1687                 gnu_sparse_old_parse(tar, ext->sparse, 21);
1688         } while (ext->isextended[0] != 0);
1689         if (tar->sparse_list != NULL)
1690                 tar->entry_offset = tar->sparse_list->offset;
1691         return (ARCHIVE_OK);
1692 }
1693
1694 static void
1695 gnu_sparse_old_parse(struct tar *tar,
1696     const struct gnu_sparse *sparse, int length)
1697 {
1698         while (length > 0 && sparse->offset[0] != 0) {
1699                 gnu_add_sparse_entry(tar,
1700                     tar_atol(sparse->offset, sizeof(sparse->offset)),
1701                     tar_atol(sparse->numbytes, sizeof(sparse->numbytes)));
1702                 sparse++;
1703                 length--;
1704         }
1705 }
1706
1707 /*
1708  * GNU tar sparse format 0.0
1709  *
1710  * Beginning with GNU tar 1.15, sparse files are stored using
1711  * information in the pax extended header.  The GNU tar maintainers
1712  * have gone through a number of variations in the process of working
1713  * out this scheme; furtunately, they're all numbered.
1714  *
1715  * Sparse format 0.0 uses attribute GNU.sparse.numblocks to store the
1716  * number of blocks, and GNU.sparse.offset/GNU.sparse.numbytes to
1717  * store offset/size for each block.  The repeated instances of these
1718  * latter fields violate the pax specification (which frowns on
1719  * duplicate keys), so this format was quickly replaced.
1720  */
1721
1722 /*
1723  * GNU tar sparse format 0.1
1724  *
1725  * This version replaced the offset/numbytes attributes with
1726  * a single "map" attribute that stored a list of integers.  This
1727  * format had two problems: First, the "map" attribute could be very
1728  * long, which caused problems for some implementations.  More
1729  * importantly, the sparse data was lost when extracted by archivers
1730  * that didn't recognize this extension.
1731  */
1732
1733 static int
1734 gnu_sparse_01_parse(struct tar *tar, const wchar_t *p)
1735 {
1736         const wchar_t *e;
1737         off_t offset = -1, size = -1;
1738
1739         for (;;) {
1740                 e = p;
1741                 while (*e != '\0' && *e != ',') {
1742                         if (*e < '0' || *e > '9')
1743                                 return (ARCHIVE_WARN);
1744                         e++;
1745                 }
1746                 if (offset < 0) {
1747                         offset = tar_atol10(p, e - p);
1748                         if (offset < 0)
1749                                 return (ARCHIVE_WARN);
1750                 } else {
1751                         size = tar_atol10(p, e - p);
1752                         if (size < 0)
1753                                 return (ARCHIVE_WARN);
1754                         gnu_add_sparse_entry(tar, offset, size);
1755                         offset = -1;
1756                 }
1757                 if (*e == '\0')
1758                         return (ARCHIVE_OK);
1759                 p = e + 1;
1760         }
1761 }
1762
1763 /*
1764  * GNU tar sparse format 1.0
1765  *
1766  * The idea: The offset/size data is stored as a series of base-10
1767  * ASCII numbers prepended to the file data, so that dearchivers that
1768  * don't support this format will extract the block map along with the
1769  * data and a separate post-process can restore the sparseness.
1770  *
1771  * Unfortunately, GNU tar 1.16 adds bogus padding to the end of the
1772  * entry that depends on the size of the map; this means we have to
1773  * parse the sparse map when we read the header (otherwise, entry_skip
1774  * will fail).  This is why sparse_10_read is called from read_header
1775  * above, instead of at the beginning of read_data, where it "should"
1776  * go.
1777  *
1778  * This variant also replaced GNU.sparse.size with GNU.sparse.realsize
1779  * and introduced the GNU.sparse.major/GNU.sparse.minor attributes.
1780  */
1781
1782 /*
1783  * Read the next line from the input, and parse it as a decimal
1784  * integer followed by '\n'.  Returns positive integer value or
1785  * negative on error.
1786  */
1787 static int64_t
1788 gnu_sparse_10_atol(struct archive_read *a, struct tar *tar,
1789     ssize_t *total_read)
1790 {
1791         int64_t l, limit, last_digit_limit;
1792         const char *p;
1793         ssize_t bytes_read;
1794         int base, digit;
1795
1796         base = 10;
1797         limit = INT64_MAX / base;
1798         last_digit_limit = INT64_MAX % base;
1799
1800         bytes_read = readline(a, tar, &p);
1801         if (bytes_read <= 0)
1802                 return (ARCHIVE_FATAL);
1803         *total_read += bytes_read;
1804
1805         l = 0;
1806         while (bytes_read > 0) {
1807                 if (*p == '\n')
1808                         return (l);
1809                 if (*p < '0' || *p >= '0' + base)
1810                         return (ARCHIVE_WARN);
1811                 digit = *p - '0';
1812                 if (l > limit || (l == limit && digit > last_digit_limit))
1813                         l = UINT64_MAX; /* Truncate on overflow. */
1814                 else
1815                         l = (l * base) + digit;
1816                 p++;
1817                 bytes_read--;
1818         }
1819         /* TODO: Error message. */
1820         return (ARCHIVE_WARN);
1821 }
1822
1823 /*
1824  * Returns number of bytes consumed to read the sparse block data.
1825  */
1826 static ssize_t
1827 gnu_sparse_10_read(struct archive_read *a, struct tar *tar)
1828 {
1829         ssize_t bytes_read = 0;
1830         int entries;
1831         off_t offset, size, to_skip;
1832
1833         /* Parse entries. */
1834         entries = gnu_sparse_10_atol(a, tar, &bytes_read);
1835         if (entries < 0)
1836                 return (ARCHIVE_FATAL);
1837         /* Parse the individual entries. */
1838         while (entries-- > 0) {
1839                 /* Parse offset/size */
1840                 offset = gnu_sparse_10_atol(a, tar, &bytes_read);
1841                 if (offset < 0)
1842                         return (ARCHIVE_FATAL);
1843                 size = gnu_sparse_10_atol(a, tar, &bytes_read);
1844                 if (size < 0)
1845                         return (ARCHIVE_FATAL);
1846                 /* Add a new sparse entry. */
1847                 gnu_add_sparse_entry(tar, offset, size);
1848         }
1849         /* Skip rest of block... */
1850         to_skip = 0x1ff & -bytes_read;
1851         if (to_skip != (a->decompressor->skip)(a, to_skip))
1852                 return (ARCHIVE_FATAL);
1853         return (bytes_read + to_skip);
1854 }
1855
1856 /*-
1857  * Convert text->integer.
1858  *
1859  * Traditional tar formats (including POSIX) specify base-8 for
1860  * all of the standard numeric fields.  This is a significant limitation
1861  * in practice:
1862  *   = file size is limited to 8GB
1863  *   = rdevmajor and rdevminor are limited to 21 bits
1864  *   = uid/gid are limited to 21 bits
1865  *
1866  * There are two workarounds for this:
1867  *   = pax extended headers, which use variable-length string fields
1868  *   = GNU tar and STAR both allow either base-8 or base-256 in
1869  *      most fields.  The high bit is set to indicate base-256.
1870  *
1871  * On read, this implementation supports both extensions.
1872  */
1873 static int64_t
1874 tar_atol(const char *p, unsigned char_cnt)
1875 {
1876         /*
1877          * Technically, GNU tar considers a field to be in base-256
1878          * only if the first byte is 0xff or 0x80.
1879          */
1880         if (*p & 0x80)
1881                 return (tar_atol256(p, char_cnt));
1882         return (tar_atol8(p, char_cnt));
1883 }
1884
1885 /*
1886  * Note that this implementation does not (and should not!) obey
1887  * locale settings; you cannot simply substitute strtol here, since
1888  * it does obey locale.
1889  */
1890 static int64_t
1891 tar_atol8(const char *p, unsigned char_cnt)
1892 {
1893         int64_t l, limit, last_digit_limit;
1894         int digit, sign, base;
1895
1896         base = 8;
1897         limit = INT64_MAX / base;
1898         last_digit_limit = INT64_MAX % base;
1899
1900         while (*p == ' ' || *p == '\t')
1901                 p++;
1902         if (*p == '-') {
1903                 sign = -1;
1904                 p++;
1905         } else
1906                 sign = 1;
1907
1908         l = 0;
1909         digit = *p - '0';
1910         while (digit >= 0 && digit < base  && char_cnt-- > 0) {
1911                 if (l>limit || (l == limit && digit > last_digit_limit)) {
1912                         l = UINT64_MAX; /* Truncate on overflow. */
1913                         break;
1914                 }
1915                 l = (l * base) + digit;
1916                 digit = *++p - '0';
1917         }
1918         return (sign < 0) ? -l : l;
1919 }
1920
1921 /*
1922  * Note that this implementation does not (and should not!) obey
1923  * locale settings; you cannot simply substitute strtol here, since
1924  * it does obey locale.
1925  */
1926 static int64_t
1927 tar_atol10(const wchar_t *p, unsigned char_cnt)
1928 {
1929         int64_t l, limit, last_digit_limit;
1930         int base, digit, sign;
1931
1932         base = 10;
1933         limit = INT64_MAX / base;
1934         last_digit_limit = INT64_MAX % base;
1935
1936         while (*p == ' ' || *p == '\t')
1937                 p++;
1938         if (*p == '-') {
1939                 sign = -1;
1940                 p++;
1941         } else
1942                 sign = 1;
1943
1944         l = 0;
1945         digit = *p - '0';
1946         while (digit >= 0 && digit < base  && char_cnt-- > 0) {
1947                 if (l > limit || (l == limit && digit > last_digit_limit)) {
1948                         l = UINT64_MAX; /* Truncate on overflow. */
1949                         break;
1950                 }
1951                 l = (l * base) + digit;
1952                 digit = *++p - '0';
1953         }
1954         return (sign < 0) ? -l : l;
1955 }
1956
1957 /*
1958  * Parse a base-256 integer.  This is just a straight signed binary
1959  * value in big-endian order, except that the high-order bit is
1960  * ignored.  Remember that "int64_t" may or may not be exactly 64
1961  * bits; the implementation here tries to avoid making any assumptions
1962  * about the actual size of an int64_t.  It does assume we're using
1963  * twos-complement arithmetic, though.
1964  */
1965 static int64_t
1966 tar_atol256(const char *_p, unsigned char_cnt)
1967 {
1968         int64_t l, upper_limit, lower_limit;
1969         const unsigned char *p = (const unsigned char *)_p;
1970
1971         upper_limit = INT64_MAX / 256;
1972         lower_limit = INT64_MIN / 256;
1973
1974         /* Pad with 1 or 0 bits, depending on sign. */
1975         if ((0x40 & *p) == 0x40)
1976                 l = (int64_t)-1;
1977         else
1978                 l = 0;
1979         l = (l << 6) | (0x3f & *p++);
1980         while (--char_cnt > 0) {
1981                 if (l > upper_limit) {
1982                         l = INT64_MAX; /* Truncate on overflow */
1983                         break;
1984                 } else if (l < lower_limit) {
1985                         l = INT64_MIN;
1986                         break;
1987                 }
1988                 l = (l << 8) | (0xff & (int64_t)*p++);
1989         }
1990         return (l);
1991 }
1992
1993 /*
1994  * Returns length of line (including trailing newline)
1995  * or negative on error.  'start' argument is updated to
1996  * point to first character of line.  This avoids copying
1997  * when possible.
1998  */
1999 static ssize_t
2000 readline(struct archive_read *a, struct tar *tar, const char **start)
2001 {
2002         ssize_t bytes_read;
2003         ssize_t total_size = 0;
2004         const void *t;
2005         const char *s;
2006         void *p;
2007
2008         bytes_read = (a->decompressor->read_ahead)(a, &t, 1);
2009         if (bytes_read <= 0)
2010                 return (ARCHIVE_FATAL);
2011         s = t;  /* Start of line? */
2012         p = memchr(t, '\n', bytes_read);
2013         /* If we found '\n' in the read buffer, return pointer to that. */
2014         if (p != NULL) {
2015                 bytes_read = 1 + ((const char *)p) - s;
2016                 (a->decompressor->consume)(a, bytes_read);
2017                 *start = s;
2018                 return (bytes_read);
2019         }
2020         /* Otherwise, we need to accumulate in a line buffer. */
2021         for (;;) {
2022                 archive_string_ensure(&tar->line, total_size + bytes_read);
2023                 memcpy(tar->line.s + total_size, t, bytes_read);
2024                 (a->decompressor->consume)(a, bytes_read);
2025                 total_size += bytes_read;
2026                 /* If we found '\n', clean up and return. */
2027                 if (p != NULL) {
2028                         *start = tar->line.s;
2029                         return (total_size);
2030                 }
2031                 /* Read some more. */
2032                 bytes_read = (a->decompressor->read_ahead)(a, &t, 1);
2033                 if (bytes_read <= 0)
2034                         return (ARCHIVE_FATAL);
2035                 s = t;  /* Start of line? */
2036                 p = memchr(t, '\n', bytes_read);
2037                 /* If we found '\n', trim the read. */
2038                 if (p != NULL) {
2039                         bytes_read = 1 + ((const char *)p) - s;
2040                 }
2041         }
2042 }
2043
2044 static int
2045 utf8_decode(wchar_t *dest, const char *src, size_t length)
2046 {
2047         size_t n;
2048         int err;
2049
2050         err = 0;
2051         while (length > 0) {
2052                 n = UTF8_mbrtowc(dest, src, length);
2053                 if (n == 0)
2054                         break;
2055                 dest++;
2056                 src += n;
2057                 length -= n;
2058         }
2059         *dest++ = L'\0';
2060         return (err);
2061 }
2062
2063 /*
2064  * Copied and simplified from FreeBSD libc/locale.
2065  */
2066 static size_t
2067 UTF8_mbrtowc(wchar_t *pwc, const char *s, size_t n)
2068 {
2069         int ch, i, len, mask;
2070         unsigned long wch;
2071
2072         if (s == NULL || n == 0 || pwc == NULL)
2073                 return (0);
2074
2075         /*
2076          * Determine the number of octets that make up this character from
2077          * the first octet, and a mask that extracts the interesting bits of
2078          * the first octet.
2079          */
2080         ch = (unsigned char)*s;
2081         if ((ch & 0x80) == 0) {
2082                 mask = 0x7f;
2083                 len = 1;
2084         } else if ((ch & 0xe0) == 0xc0) {
2085                 mask = 0x1f;
2086                 len = 2;
2087         } else if ((ch & 0xf0) == 0xe0) {
2088                 mask = 0x0f;
2089                 len = 3;
2090         } else if ((ch & 0xf8) == 0xf0) {
2091                 mask = 0x07;
2092                 len = 4;
2093         } else if ((ch & 0xfc) == 0xf8) {
2094                 mask = 0x03;
2095                 len = 5;
2096         } else if ((ch & 0xfe) == 0xfc) {
2097                 mask = 0x01;
2098                 len = 6;
2099         } else {
2100                 /* Invalid first byte; convert to '?' */
2101                 *pwc = '?';
2102                 return (1);
2103         }
2104
2105         if (n < (size_t)len) {
2106                 /* Invalid first byte; convert to '?' */
2107                 *pwc = '?';
2108                 return (1);
2109         }
2110
2111         /*
2112          * Decode the octet sequence representing the character in chunks
2113          * of 6 bits, most significant first.
2114          */
2115         wch = (unsigned char)*s++ & mask;
2116         i = len;
2117         while (--i != 0) {
2118                 if ((*s & 0xc0) != 0x80) {
2119                         /* Invalid intermediate byte; consume one byte and
2120                          * emit '?' */
2121                         *pwc = '?';
2122                         return (1);
2123                 }
2124                 wch <<= 6;
2125                 wch |= *s++ & 0x3f;
2126         }
2127
2128         /* Assign the value to the output; out-of-range values
2129          * just get truncated. */
2130         *pwc = (wchar_t)wch;
2131 #ifdef WCHAR_MAX
2132         /*
2133          * If platform has WCHAR_MAX, we can do something
2134          * more sensible with out-of-range values.
2135          */
2136         if (wch >= WCHAR_MAX)
2137                 *pwc = '?';
2138 #endif
2139         /* Return number of bytes input consumed: 0 for end-of-string. */
2140         return (wch == L'\0' ? 0 : len);
2141 }
2142
2143
2144 /*
2145  * base64_decode - Base64 decode
2146  *
2147  * This accepts most variations of base-64 encoding, including:
2148  *    * with or without line breaks
2149  *    * with or without the final group padded with '=' or '_' characters
2150  * (The most economical Base-64 variant does not pad the last group and
2151  * omits line breaks; RFC1341 used for MIME requires both.)
2152  */
2153 static char *
2154 base64_decode(const wchar_t *src, size_t len, size_t *out_len)
2155 {
2156         static const unsigned char digits[64] = {
2157                 'A','B','C','D','E','F','G','H','I','J','K','L','M','N',
2158                 'O','P','Q','R','S','T','U','V','W','X','Y','Z','a','b',
2159                 'c','d','e','f','g','h','i','j','k','l','m','n','o','p',
2160                 'q','r','s','t','u','v','w','x','y','z','0','1','2','3',
2161                 '4','5','6','7','8','9','+','/' };
2162         static unsigned char decode_table[128];
2163         char *out, *d;
2164
2165         /* If the decode table is not yet initialized, prepare it. */
2166         if (decode_table[digits[1]] != 1) {
2167                 size_t i;
2168                 memset(decode_table, 0xff, sizeof(decode_table));
2169                 for (i = 0; i < sizeof(digits); i++)
2170                         decode_table[digits[i]] = i;
2171         }
2172
2173         /* Allocate enough space to hold the entire output. */
2174         /* Note that we may not use all of this... */
2175         out = (char *)malloc((len * 3 + 3) / 4);
2176         if (out == NULL) {
2177                 *out_len = 0;
2178                 return (NULL);
2179         }
2180         d = out;
2181
2182         while (len > 0) {
2183                 /* Collect the next group of (up to) four characters. */
2184                 int v = 0;
2185                 int group_size = 0;
2186                 while (group_size < 4 && len > 0) {
2187                         /* '=' or '_' padding indicates final group. */
2188                         if (*src == '=' || *src == '_') {
2189                                 len = 0;
2190                                 break;
2191                         }
2192                         /* Skip illegal characters (including line breaks) */
2193                         if (*src > 127 || *src < 32
2194                             || decode_table[*src] == 0xff) {
2195                                 len--;
2196                                 src++;
2197                                 continue;
2198                         }
2199                         v <<= 6;
2200                         v |= decode_table[*src++];
2201                         len --;
2202                         group_size++;
2203                 }
2204                 /* Align a short group properly. */
2205                 v <<= 6 * (4 - group_size);
2206                 /* Unpack the group we just collected. */
2207                 switch (group_size) {
2208                 case 4: d[2] = v & 0xff;
2209                         /* FALLTHROUGH */
2210                 case 3: d[1] = (v >> 8) & 0xff;
2211                         /* FALLTHROUGH */
2212                 case 2: d[0] = (v >> 16) & 0xff;
2213                         break;
2214                 case 1: /* this is invalid! */
2215                         break;
2216                 }
2217                 d += group_size * 3 / 4;
2218         }
2219
2220         *out_len = d - out;
2221         return (out);
2222 }
2223
2224 /*
2225  * This is a little tricky because the C99 standard wcstombs()
2226  * function returns the number of bytes that were converted,
2227  * not the number that should be converted.  As a result,
2228  * we can never accurately size the output buffer (without
2229  * doing a tedious output size calculation in advance).
2230  * This approach (try a conversion, then try again if it fails)
2231  * will almost always succeed on the first try, and is thus
2232  * much faster, at the cost of sometimes requiring multiple
2233  * passes while we expand the buffer.
2234  */
2235 static char *
2236 wide_to_narrow(const wchar_t *wval)
2237 {
2238         int converted_length;
2239         /* Guess an output buffer size and try the conversion. */
2240         int alloc_length = wcslen(wval) * 3;
2241         char *mbs_val = (char *)malloc(alloc_length + 1);
2242         if (mbs_val == NULL)
2243                 return (NULL);
2244         converted_length = wcstombs(mbs_val, wval, alloc_length);
2245
2246         /* If we exhausted the buffer, resize and try again. */
2247         while (converted_length >= alloc_length) {
2248                 free(mbs_val);
2249                 alloc_length *= 2;
2250                 mbs_val = (char *)malloc(alloc_length + 1);
2251                 if (mbs_val == NULL)
2252                         return (NULL);
2253                 converted_length = wcstombs(mbs_val, wval, alloc_length);
2254         }
2255
2256         /* Ensure a trailing null and return the final string. */
2257         mbs_val[alloc_length] = '\0';
2258         return (mbs_val);
2259 }
2260
2261 static char *
2262 url_decode(const char *in)
2263 {
2264         char *out, *d;
2265         const char *s;
2266
2267         out = (char *)malloc(strlen(in) + 1);
2268         if (out == NULL)
2269                 return (NULL);
2270         for (s = in, d = out; *s != '\0'; ) {
2271                 if (*s == '%') {
2272                         /* Try to convert % escape */
2273                         int digit1 = tohex(s[1]);
2274                         int digit2 = tohex(s[2]);
2275                         if (digit1 >= 0 && digit2 >= 0) {
2276                                 /* Looks good, consume three chars */
2277                                 s += 3;
2278                                 /* Convert output */
2279                                 *d++ = ((digit1 << 4) | digit2);
2280                                 continue;
2281                         }
2282                         /* Else fall through and treat '%' as normal char */
2283                 }
2284                 *d++ = *s++;
2285         }
2286         *d = '\0';
2287         return (out);
2288 }
2289
2290 static int
2291 tohex(int c)
2292 {
2293         if (c >= '0' && c <= '9')
2294                 return (c - '0');
2295         else if (c >= 'A' && c <= 'F')
2296                 return (c - 'A' + 10);
2297         else if (c >= 'a' && c <= 'f')
2298                 return (c - 'a' + 10);
2299         else
2300                 return (-1);
2301 }