tar: correctly skip (and warn about) pax headers.
[oweals/busybox.git] / archival / libunarchive / get_header_tar.c
1 /* vi: set sw=4 ts=4: */
2 /* Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
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 "unarchive.h"
16
17 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
18 static char *longname;
19 static char *linkname;
20 #else
21 enum {
22         longname = 0,
23         linkname = 0,
24 };
25 #endif
26
27 /* NB: _DESTROYS_ str[len] character! */
28 static unsigned long long getOctal(char *str, int len)
29 {
30         unsigned long long v;
31         /* Actually, tar header allows leading spaces also.
32          * Oh well, we will be liberal and skip this...
33          * The only downside probably is that we allow "-123" too :)
34         if (*str < '0' || *str > '7')
35                 bb_error_msg_and_die("corrupted octal value in tar header");
36         */
37         str[len] = '\0';
38         v = strtoull(str, &str, 8);
39         if (*str)
40                 bb_error_msg_and_die("corrupted octal value in tar header");
41         return v;
42 }
43 #define GET_OCTAL(a) getOctal((a), sizeof(a))
44
45 void BUG_tar_header_size(void);
46 char get_header_tar(archive_handle_t *archive_handle)
47 {
48         static int end;
49
50         file_header_t *file_header = archive_handle->file_header;
51         struct {
52                 /* ustar header, Posix 1003.1 */
53                 char name[100];     /*   0-99 */
54                 char mode[8];       /* 100-107 */
55                 char uid[8];        /* 108-115 */
56                 char gid[8];        /* 116-123 */
57                 char size[12];      /* 124-135 */
58                 char mtime[12];     /* 136-147 */
59                 char chksum[8];     /* 148-155 */
60                 char typeflag;      /* 156-156 */
61                 char linkname[100]; /* 157-256 */
62                 char magic[6];      /* 257-262 */
63                 char version[2];    /* 263-264 */
64                 char uname[32];     /* 265-296 */
65                 char gname[32];     /* 297-328 */
66                 char devmajor[8];   /* 329-336 */
67                 char devminor[8];   /* 337-344 */
68                 char prefix[155];   /* 345-499 */
69                 char padding[12];   /* 500-512 */
70         } tar;
71         char *cp;
72         int sum, i;
73         int parse_names;
74
75         if (sizeof(tar) != 512)
76                 BUG_tar_header_size();
77  again:
78
79         /* Align header */
80         data_align(archive_handle, 512);
81
82  again_after_align:
83
84         xread(archive_handle->src_fd, &tar, 512);
85         archive_handle->offset += 512;
86
87         /* If there is no filename its an empty header */
88         if (tar.name[0] == 0) {
89                 if (end) {
90                         /* This is the second consecutive empty header! End of archive!
91                          * Read until the end to empty the pipe from gz or bz2
92                          */
93                         while (full_read(archive_handle->src_fd, &tar, 512) == 512)
94                                 /* repeat */;
95                         return EXIT_FAILURE;
96                 }
97                 end = 1;
98                 return EXIT_SUCCESS;
99         }
100         end = 0;
101
102         /* Check header has valid magic, "ustar" is for the proper tar
103          * 0's are for the old tar format
104          */
105         if (strncmp(tar.magic, "ustar", 5) != 0) {
106 #if ENABLE_FEATURE_TAR_OLDGNU_COMPATIBILITY
107                 if (memcmp(tar.magic, "\0\0\0\0", 5) != 0)
108 #endif
109                         bb_error_msg_and_die("invalid tar magic");
110         }
111         /* Do checksum on headers */
112         sum = ' ' * sizeof(tar.chksum);
113         for (i = 0; i < 148 ; i++) {
114                 sum += ((char*)&tar)[i];
115         }
116         for (i = 156; i < 512 ; i++) {
117                 sum += ((char*)&tar)[i];
118         }
119         /* This field does not need special treatment (getOctal) */
120         if (sum != xstrtoul(tar.chksum, 8)) {
121                 bb_error_msg_and_die("invalid tar header checksum");
122         }
123
124         /* 0 is reserved for high perf file, treat as normal file */
125         if (!tar.typeflag) tar.typeflag = '0';
126         parse_names = (tar.typeflag >= '0' && tar.typeflag <= '7');
127
128         /* getOctal trashes subsequent field, therefore we call it
129          * on fields in reverse order */
130         if (tar.devmajor[0]) {
131                 unsigned minor = GET_OCTAL(tar.devminor);
132                 unsigned major = GET_OCTAL(tar.devmajor);
133                 file_header->device = makedev(major, minor);
134         }
135         file_header->link_name = NULL;
136         if (!linkname && parse_names && tar.linkname[0]) {
137                 /* we trash magic[0] here, it's ok */
138                 tar.linkname[sizeof(tar.linkname)] = '\0';
139                 file_header->link_name = xstrdup(tar.linkname);
140                 /* FIXME: what if we have non-link object with link_name? */
141                 /* Will link_name be free()ed? */
142         }
143         file_header->mtime = GET_OCTAL(tar.mtime);
144         file_header->size = GET_OCTAL(tar.size);
145         file_header->gid = GET_OCTAL(tar.gid);
146         file_header->uid = GET_OCTAL(tar.uid);
147         /* Set bits 0-11 of the files mode */
148         file_header->mode = 07777 & GET_OCTAL(tar.mode);
149
150         file_header->name = NULL;
151         if (!longname && parse_names) {
152                 /* we trash mode[0] here, it's ok */
153                 tar.name[sizeof(tar.name)] = '\0';
154                 if (tar.prefix[0]) {
155                         /* and padding[0] */
156                         tar.prefix[sizeof(tar.prefix)] = '\0';
157                         file_header->name = concat_path_file(tar.prefix, tar.name);
158                 } else
159                         file_header->name = xstrdup(tar.name);
160                 /* FIXME: add check for /../ attacks */
161         }
162
163         /* Set bits 12-15 of the files mode */
164         /* (typeflag was not trashed because chksum does not use getOctal) */
165         switch (tar.typeflag) {
166         /* busybox identifies hard links as being regular files with 0 size and a link name */
167         case '1':
168                 file_header->mode |= S_IFREG;
169                 break;
170         case '7':
171         /* case 0: */
172         case '0':
173 #if ENABLE_FEATURE_TAR_OLDGNU_COMPATIBILITY
174                 if (last_char_is(file_header->name, '/')) {
175                         file_header->mode |= S_IFDIR;
176                 } else
177 #endif
178                 file_header->mode |= S_IFREG;
179                 break;
180         case '2':
181                 file_header->mode |= S_IFLNK;
182                 break;
183         case '3':
184                 file_header->mode |= S_IFCHR;
185                 break;
186         case '4':
187                 file_header->mode |= S_IFBLK;
188                 break;
189         case '5':
190                 file_header->mode |= S_IFDIR;
191                 break;
192         case '6':
193                 file_header->mode |= S_IFIFO;
194                 break;
195 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
196         case 'L':
197                 /* free: paranoia: tar with several consecutive longnames */
198                 free(longname);
199                 /* For paranoia reasons we allocate extra NUL char */
200                 longname = xzalloc(file_header->size + 1);
201                 /* We read ASCIZ string, including NUL */
202                 xread(archive_handle->src_fd, longname, file_header->size);
203                 archive_handle->offset += file_header->size;
204                 /* return get_header_tar(archive_handle); */
205                 /* gcc 4.1.1 didn't optimize it into jump */
206                 /* so we will do it ourself, this also saves stack */
207                 goto again;
208         case 'K':
209                 free(linkname);
210                 linkname = xzalloc(file_header->size + 1);
211                 xread(archive_handle->src_fd, linkname, file_header->size);
212                 archive_handle->offset += file_header->size;
213                 /* return get_header_tar(archive_handle); */
214                 goto again;
215         case 'D':       /* GNU dump dir */
216         case 'M':       /* Continuation of multi volume archive */
217         case 'N':       /* Old GNU for names > 100 characters */
218         case 'S':       /* Sparse file */
219         case 'V':       /* Volume header */
220 #endif
221         case 'g':       /* pax global header */
222         case 'x': {     /* pax extended header */
223                 off_t sz;
224                 bb_error_msg("warning: skipping header '%c'", tar.typeflag);
225                 sz = (file_header->size + 511) & ~(off_t)511;
226                 archive_handle->offset += sz;
227                 sz >>= 9; /* sz /= 512 but w/o contortions for signed div */
228                 while (sz--)
229                         xread(archive_handle->src_fd, &tar, 512);
230                 /* return get_header_tar(archive_handle); */
231                 goto again_after_align;
232         }
233         default:
234                 bb_error_msg_and_die("unknown typeflag: 0x%x", tar.typeflag);
235         }
236
237 #if ENABLE_FEATURE_TAR_GNU_EXTENSIONS
238         if (longname) {
239                 file_header->name = longname;
240                 longname = NULL;
241         }
242         if (linkname) {
243                 file_header->link_name = linkname;
244                 linkname = NULL;
245         }
246 #endif
247
248         /* Strip trailing '/' in directories */
249         /* Must be done after mode is set as '/' is used to check if its a directory */
250         cp = last_char_is(file_header->name, '/');
251
252         if (archive_handle->filter(archive_handle) == EXIT_SUCCESS) {
253                 archive_handle->action_header(archive_handle->file_header);
254                 /* Note that we kill the '/' only after action_header() */
255                 /* (like GNU tar 1.15.1: verbose mode outputs "dir/dir/") */
256                 if (cp) *cp = '\0';
257                 archive_handle->flags |= ARCHIVE_EXTRACT_QUIET;
258                 archive_handle->action_data(archive_handle);
259                 llist_add_to(&(archive_handle->passed), file_header->name);
260         } else {
261                 data_skip(archive_handle);
262                 free(file_header->name);
263         }
264         archive_handle->offset += file_header->size;
265
266         free(file_header->link_name);
267         /* Do not free(file_header->name)! */
268
269         return EXIT_SUCCESS;
270 }