archival/libarchive/get_header_tar.c

   1 /* vi: set sw=4 ts=4: */
   2 /* Licensed under GPLv2 or later, see file LICENSE in this source tree.
   3  *
   4  * FIXME:
   5  *    In privileged mode if uname and gname map to a uid and gid then use the
   6  *    mapped value instead of the uid/gid values in tar header
   7  *
   8  * References:
   9  *    GNU tar and star man pages,
  10  *    Opengroup's ustar interchange format,
  11  *    http://www.opengroup.org/onlinepubs/007904975/utilities/pax.html
  12  */
  13
  14 #include "libbb.h"
  15 #include "bb_archive.h"
  16
  17 typedef uint32_t aliased_uint32_t FIX_ALIASING;
  18 typedef off_t    aliased_off_t    FIX_ALIASING;
  19
  20 /* NB: _DESTROYS_ str[len] character! */
  21 static unsigned long long getOctal(char *str, int len)
  22 {
  23         unsigned long long v;
  24         char *end;
  25         /* NB: leading spaces are allowed. Using strtoull to handle that.
  26          * The downside is that we accept e.g. "-123" too :(
  27          */
  28         str[len] = '\0';
  29         v = strtoull(str, &end, 8);
  30         /* std: "Each numeric field is terminated by one or more
  31          * <space> or NUL characters". We must support ' '! */
  32         if (*end != '\0' && *end != ' ') {
  33                 int8_t first = str[0];
  34                 if (!(first & 0x80))
  35                         bb_error_msg_and_die("corrupted octal value in tar header");
  36                 /*
  37                  * GNU tar uses "base-256 encoding" for very large numbers.
  38                  * Encoding is binary, with highest bit always set as a marker
  39                  * and sign in next-highest bit:
  40                  * 80 00 .. 00 - zero
  41                  * bf ff .. ff - largest positive number
  42                  * ff ff .. ff - minus 1
  43                  * c0 00 .. 00 - smallest negative number
  44                  *
  45                  * Example of tar file with 8914993153 (0x213600001) byte file.
  46                  * Field starts at offset 7c:
  47                  * 00070  30 30 30 00 30 30 30 30  30 30 30 00 80 00 00 00  |000.0000000.....|
  48                  * 00080  00 00 00 02 13 60 00 01  31 31 31 32 30 33 33 36  |.....`..11120336|
  49                  *
  50                  * NB: tarballs with NEGATIVE unix times encoded that way were seen!
  51                  */
  52                 /* Sign-extend 7bit 'first' to 64bit 'v' (that is, using 6th bit as sign): */
  53                 first <<= 1;
  54                 first >>= 1; /* now 7th bit = 6th bit */
  55                 v = first;   /* sign-extend 8 bits to 64 */
  56                 while (--len != 0)
  57                         v = (v << 8) + (uint8_t) *++str;
  58         }
  59         return v;
  60 }
  61 #define GET_OCTAL(a) getOctal((a), sizeof(a))
  62
  63 /* "global" is 0 or 1 */
  64 static void process_pax_hdr(archive_handle_t *archive_handle, unsigned sz, int global)
  65 {
  66         char *buf, *p;
  67         unsigned blk_sz;
  68
  69         blk_sz = (sz + 511) & (~511);
  70         p = buf = xmalloc(blk_sz + 1);
  71         xread(archive_handle->src_fd, buf, blk_sz);
  72         archive_handle->offset += blk_sz;
  73
  74         /* prevent bb_strtou from running off the buffer */
  75         buf[sz] = '\0';
  76
  77         while (sz != 0) {
  78                 char *end, *value;
  79                 unsigned len;
  80
  81                 /* Every record has this format: "LEN NAME=VALUE\n" */
  82                 len = bb_strtou(p, &end, 10);
  83                 /* expect errno to be EINVAL, because the character
  84                  * following the digits should be a space
  85                  */
  86                 p += len;
  87                 sz -= len;
  88                 if (
  89                 /** (int)sz < 0 - not good enough for huge malicious VALUE of 2^32-1 */
  90                     (int)(sz|len) < 0 /* this works */
  91                  || len == 0
  92                  || errno != EINVAL
  93                  || *end != ' '
  94                 ) {
  95                         bb_error_msg("malformed extended header, skipped");
  96                         // More verbose version:
  97                         //bb_error_msg("malformed extended header at %"OFF_FMT"d, skipped",
  98                         //              archive_handle->offset - (sz + len));
  99                         break;
 100                 }
 101                 /* overwrite the terminating newline with NUL
 102                  * (we do not bother to check that it *was* a newline)
 103                  */
 104                 p[-1] = '\0';
 105                 value = end + 1;
 106
 107 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
 108                 if (!global && is_prefixed_with(value, "path=")) {
 109                         value += sizeof("path=") - 1;
 110                         free(archive_handle->tar__longname);
 111                         archive_handle->tar__longname = xstrdup(value);
 112                         continue;
 113                 }
 114 #endif
 115
 116 #if ENABLE_FEATURE_TAR_SELINUX
 117                 /* Scan for SELinux contexts, via "RHT.security.selinux" keyword.
 118                  * This is what Red Hat's patched version of tar uses.
 119                  */
 120 # define SELINUX_CONTEXT_KEYWORD "RHT.security.selinux"
 121                 if (is_prefixed_with(value, SELINUX_CONTEXT_KEYWORD"=")) {
 122                         value += sizeof(SELINUX_CONTEXT_KEYWORD"=") - 1;
 123                         free(archive_handle->tar__sctx[global]);
 124                         archive_handle->tar__sctx[global] = xstrdup(value);
 125                         continue;
 126                 }
 127 #endif
 128         }
 129
 130         free(buf);
 131 }
 132
 133 char FAST_FUNC get_header_tar(archive_handle_t *archive_handle)
 134 {
 135         file_header_t *file_header = archive_handle->file_header;
 136         struct tar_header_t tar;
 137         char *cp;
 138         int i, sum_u, sum;
 139 #if ENABLE_FEATURE_TAR_OLDSUN_COMPATIBILITY
 140         int sum_s;
 141 #endif
 142         int parse_names;
 143
 144         /* Our "private data" */
 145 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
 146 # define p_longname (archive_handle->tar__longname)
 147 # define p_linkname (archive_handle->tar__linkname)
 148 #else
 149 # define p_longname 0
 150 # define p_linkname 0
 151 #endif
 152
 153 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS || ENABLE_FEATURE_TAR_SELINUX
 154  again:
 155 #endif
 156         /* Align header */
 157         data_align(archive_handle, 512);
 158
 159  again_after_align:
 160
 161 #if ENABLE_DESKTOP || ENABLE_FEATURE_TAR_AUTODETECT
 162         /* to prevent misdetection of bz2 sig */
 163         *(aliased_uint32_t*)&tar = 0;
 164         i = full_read(archive_handle->src_fd, &tar, 512);
 165         /* If GNU tar sees EOF in above read, it says:
 166          * "tar: A lone zero block at N", where N = kilobyte
 167          * where EOF was met (not EOF block, actual EOF!),
 168          * and exits with EXIT_SUCCESS.
 169          * We will mimic exit(EXIT_SUCCESS), although we will not mimic
 170          * the message and we don't check whether we indeed
 171          * saw zero block directly before this. */
 172         if (i == 0) {
 173                 bb_error_msg("short read");
 174                 /* this merely signals end of archive, not exit(1): */
 175                 return EXIT_FAILURE;
 176         }
 177         if (i != 512) {
 178                 IF_FEATURE_TAR_AUTODETECT(goto autodetect;)
 179                 bb_error_msg_and_die("short read");
 180         }
 181
 182 #else
 183         i = 512;
 184         xread(archive_handle->src_fd, &tar, i);
 185 #endif
 186         archive_handle->offset += i;
 187
 188         /* If there is no filename its an empty header */
 189         if (tar.name[0] == 0 && tar.prefix[0] == 0) {
 190                 if (archive_handle->tar__end) {
 191                         /* Second consecutive empty header - end of archive.
 192                          * Read until the end to empty the pipe from gz or bz2
 193                          */
 194                         while (full_read(archive_handle->src_fd, &tar, 512) == 512)
 195                                 continue;
 196                         return EXIT_FAILURE; /* "end of archive" */
 197                 }
 198                 archive_handle->tar__end = 1;
 199                 return EXIT_SUCCESS; /* "decoded one header" */
 200         }
 201         archive_handle->tar__end = 0;
 202
 203         /* Check header has valid magic, "ustar" is for the proper tar,
 204          * five NULs are for the old tar format  */
 205         if (!is_prefixed_with(tar.magic, "ustar")
 206          && (!ENABLE_FEATURE_TAR_OLDGNU_COMPATIBILITY
 207              || memcmp(tar.magic, "\0\0\0\0", 5) != 0)
 208         ) {
 209 #if ENABLE_FEATURE_TAR_AUTODETECT
 210  autodetect:
 211                 /* Two different causes for lseek() != 0:
 212                  * unseekable fd (would like to support that too, but...),
 213                  * or not first block (false positive, it's not .gz/.bz2!) */
 214                 if (lseek(archive_handle->src_fd, -i, SEEK_CUR) != 0)
 215                         goto err;
 216                 if (setup_unzip_on_fd(archive_handle->src_fd, /*fail_if_not_compressed:*/ 0) != 0)
 217  err:
 218                         bb_error_msg_and_die("invalid tar magic");
 219                 archive_handle->offset = 0;
 220                 goto again_after_align;
 221 #endif
 222                 bb_error_msg_and_die("invalid tar magic");
 223         }
 224
 225         /* Do checksum on headers.
 226          * POSIX says that checksum is done on unsigned bytes, but
 227          * Sun and HP-UX gets it wrong... more details in
 228          * GNU tar source. */
 229 #if ENABLE_FEATURE_TAR_OLDSUN_COMPATIBILITY
 230         sum_s = ' ' * sizeof(tar.chksum);
 231 #endif
 232         sum_u = ' ' * sizeof(tar.chksum);
 233         for (i = 0; i < 148; i++) {
 234                 sum_u += ((unsigned char*)&tar)[i];
 235 #if ENABLE_FEATURE_TAR_OLDSUN_COMPATIBILITY
 236                 sum_s += ((signed char*)&tar)[i];
 237 #endif
 238         }
 239         for (i = 156; i < 512; i++) {
 240                 sum_u += ((unsigned char*)&tar)[i];
 241 #if ENABLE_FEATURE_TAR_OLDSUN_COMPATIBILITY
 242                 sum_s += ((signed char*)&tar)[i];
 243 #endif
 244         }
 245         /* This field does not need special treatment (getOctal) */
 246         {
 247                 char *endp; /* gcc likes temp var for &endp */
 248                 sum = strtoul(tar.chksum, &endp, 8);
 249                 if ((*endp != '\0' && *endp != ' ')
 250                  || (sum_u != sum IF_FEATURE_TAR_OLDSUN_COMPATIBILITY(&& sum_s != sum))
 251                 ) {
 252                         bb_error_msg_and_die("invalid tar header checksum");
 253                 }
 254         }
 255         /* don't use xstrtoul, tar.chksum may have leading spaces */
 256         sum = strtoul(tar.chksum, NULL, 8);
 257         if (sum_u != sum IF_FEATURE_TAR_OLDSUN_COMPATIBILITY(&& sum_s != sum)) {
 258                 bb_error_msg_and_die("invalid tar header checksum");
 259         }
 260
 261         /* 0 is reserved for high perf file, treat as normal file */
 262         if (!tar.typeflag) tar.typeflag = '0';
 263         parse_names = (tar.typeflag >= '0' && tar.typeflag <= '7');
 264
 265         /* getOctal trashes subsequent field, therefore we call it
 266          * on fields in reverse order */
 267         if (tar.devmajor[0]) {
 268                 char t = tar.prefix[0];
 269                 /* we trash prefix[0] here, but we DO need it later! */
 270                 unsigned minor = GET_OCTAL(tar.devminor);
 271                 unsigned major = GET_OCTAL(tar.devmajor);
 272                 file_header->device = makedev(major, minor);
 273                 tar.prefix[0] = t;
 274         }
 275         file_header->link_target = NULL;
 276         if (!p_linkname && parse_names && tar.linkname[0]) {
 277                 file_header->link_target = xstrndup(tar.linkname, sizeof(tar.linkname));
 278                 /* FIXME: what if we have non-link object with link_target? */
 279                 /* Will link_target be free()ed? */
 280         }
 281 #if ENABLE_FEATURE_TAR_UNAME_GNAME
 282         file_header->tar__uname = tar.uname[0] ? xstrndup(tar.uname, sizeof(tar.uname)) : NULL;
 283         file_header->tar__gname = tar.gname[0] ? xstrndup(tar.gname, sizeof(tar.gname)) : NULL;
 284 #endif
 285         file_header->mtime = GET_OCTAL(tar.mtime);
 286         file_header->size = GET_OCTAL(tar.size);
 287         file_header->gid = GET_OCTAL(tar.gid);
 288         file_header->uid = GET_OCTAL(tar.uid);
 289         /* Set bits 0-11 of the files mode */
 290         file_header->mode = 07777 & GET_OCTAL(tar.mode);
 291
 292         file_header->name = NULL;
 293         if (!p_longname && parse_names) {
 294                 /* we trash mode[0] here, it's ok */
 295                 //tar.name[sizeof(tar.name)] = '\0'; - gcc 4.3.0 would complain
 296                 tar.mode[0] = '\0';
 297                 if (tar.prefix[0]) {
 298                         /* and padding[0] */
 299                         //tar.prefix[sizeof(tar.prefix)] = '\0'; - gcc 4.3.0 would complain
 300                         tar.padding[0] = '\0';
 301                         file_header->name = concat_path_file(tar.prefix, tar.name);
 302                 } else
 303                         file_header->name = xstrdup(tar.name);
 304         }
 305
 306         /* Set bits 12-15 of the files mode */
 307         /* (typeflag was not trashed because chksum does not use getOctal) */
 308         switch (tar.typeflag) {
 309         case '1': /* hardlink */
 310                 /* we mark hardlinks as regular files with zero size and a link name */
 311                 file_header->mode |= S_IFREG;
 312                 /* on size of link fields from star(4)
 313                  * ... For tar archives written by pre POSIX.1-1988
 314                  * implementations, the size field usually contains the size of
 315                  * the file and needs to be ignored as no data may follow this
 316                  * header type.  For POSIX.1- 1988 compliant archives, the size
 317                  * field needs to be 0.  For POSIX.1-2001 compliant archives,
 318                  * the size field may be non zero, indicating that file data is
 319                  * included in the archive.
 320                  * i.e; always assume this is zero for safety.
 321                  */
 322                 goto size0;
 323         case '7':
 324         /* case 0: */
 325         case '0':
 326 #if ENABLE_FEATURE_TAR_OLDGNU_COMPATIBILITY
 327                 if (last_char_is(file_header->name, '/')) {
 328                         goto set_dir;
 329                 }
 330 #endif
 331                 file_header->mode |= S_IFREG;
 332                 break;
 333         case '2':
 334                 file_header->mode |= S_IFLNK;
 335                 /* have seen tarballs with size field containing
 336                  * the size of the link target's name */
 337  size0:
 338                 file_header->size = 0;
 339                 break;
 340         case '3':
 341                 file_header->mode |= S_IFCHR;
 342                 goto size0; /* paranoia */
 343         case '4':
 344                 file_header->mode |= S_IFBLK;
 345                 goto size0;
 346         case '5':
 347  IF_FEATURE_TAR_OLDGNU_COMPATIBILITY(set_dir:)
 348                 file_header->mode |= S_IFDIR;
 349                 goto size0;
 350         case '6':
 351                 file_header->mode |= S_IFIFO;
 352                 goto size0;
 353         case 'g':       /* pax global header */
 354         case 'x': {     /* pax extended header */
 355                 if ((uoff_t)file_header->size > 0xfffff) /* paranoia */
 356                         goto skip_ext_hdr;
 357                 process_pax_hdr(archive_handle, file_header->size, (tar.typeflag == 'g'));
 358                 goto again_after_align;
 359 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
 360 /* See http://www.gnu.org/software/tar/manual/html_node/Extensions.html */
 361         case 'L':
 362                 /* free: paranoia: tar with several consecutive longnames */
 363                 free(p_longname);
 364                 /* For paranoia reasons we allocate extra NUL char */
 365                 p_longname = xzalloc(file_header->size + 1);
 366                 /* We read ASCIZ string, including NUL */
 367                 xread(archive_handle->src_fd, p_longname, file_header->size);
 368                 archive_handle->offset += file_header->size;
 369                 /* return get_header_tar(archive_handle); */
 370                 /* gcc 4.1.1 didn't optimize it into jump */
 371                 /* so we will do it ourself, this also saves stack */
 372                 goto again;
 373         case 'K':
 374                 free(p_linkname);
 375                 p_linkname = xzalloc(file_header->size + 1);
 376                 xread(archive_handle->src_fd, p_linkname, file_header->size);
 377                 archive_handle->offset += file_header->size;
 378                 /* return get_header_tar(archive_handle); */
 379                 goto again;
 380 /*
 381  *      case 'S':       // Sparse file
 382  * Was seen in the wild. Not supported (yet?).
 383  * See https://www.gnu.org/software/tar/manual/html_section/tar_92.html
 384  * for the format. (An "Old GNU Format" was seen, not PAX formats).
 385  */
 386 //      case 'D':       /* GNU dump dir */
 387 //      case 'M':       /* Continuation of multi volume archive */
 388 //      case 'N':       /* Old GNU for names > 100 characters */
 389 //      case 'V':       /* Volume header */
 390 #endif
 391         }
 392  skip_ext_hdr:
 393         {
 394                 off_t sz;
 395                 bb_error_msg("warning: skipping header '%c'", tar.typeflag);
 396                 sz = (file_header->size + 511) & ~(off_t)511;
 397                 archive_handle->offset += sz;
 398                 sz >>= 9; /* sz /= 512 but w/o contortions for signed div */
 399                 while (sz--)
 400                         xread(archive_handle->src_fd, &tar, 512);
 401                 /* return get_header_tar(archive_handle); */
 402                 goto again_after_align;
 403         }
 404         default:
 405                 bb_error_msg_and_die("unknown typeflag: 0x%x", tar.typeflag);
 406         }
 407
 408 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
 409         if (p_longname) {
 410                 file_header->name = p_longname;
 411                 p_longname = NULL;
 412         }
 413         if (p_linkname) {
 414                 file_header->link_target = p_linkname;
 415                 p_linkname = NULL;
 416         }
 417 #endif
 418
 419         /* Everything up to and including last ".." component is stripped */
 420         overlapping_strcpy(file_header->name, strip_unsafe_prefix(file_header->name));
 421
 422         /* Strip trailing '/' in directories */
 423         /* Must be done after mode is set as '/' is used to check if it's a directory */
 424         cp = last_char_is(file_header->name, '/');
 425
 426         if (archive_handle->filter(archive_handle) == EXIT_SUCCESS) {
 427                 archive_handle->action_header(/*archive_handle->*/ file_header);
 428                 /* Note that we kill the '/' only after action_header() */
 429                 /* (like GNU tar 1.15.1: verbose mode outputs "dir/dir/") */
 430                 if (cp)
 431                         *cp = '\0';
 432                 archive_handle->action_data(archive_handle);
 433                 if (archive_handle->accept || archive_handle->reject
 434                  || (archive_handle->ah_flags & ARCHIVE_REMEMBER_NAMES)
 435                 ) {
 436                         llist_add_to(&archive_handle->passed, file_header->name);
 437                 } else /* Caller isn't interested in list of unpacked files */
 438                         free(file_header->name);
 439         } else {
 440                 data_skip(archive_handle);
 441                 free(file_header->name);
 442         }
 443         archive_handle->offset += file_header->size;
 444
 445         free(file_header->link_target);
 446         /* Do not free(file_header->name)!
 447          * It might be inserted in archive_handle->passed - see above */
 448 #if ENABLE_FEATURE_TAR_UNAME_GNAME
 449         free(file_header->tar__uname);
 450         free(file_header->tar__gname);
 451 #endif
 452         return EXIT_SUCCESS; /* "decoded one header" */
 453 }