Synchronous libarchive to 2.2.4 from FreeBSD, including fixes related to
[dragonfly.git] / contrib / libarchive-2 / libarchive / archive_write_set_format_ustar.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_write_set_format_ustar.c,v 1.24 2007/06/11 05:17:30 kientzle Exp $");
28
29
30 #ifdef HAVE_ERRNO_H
31 #include <errno.h>
32 #endif
33 #include <stdio.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 #include "archive.h"
42 #include "archive_entry.h"
43 #include "archive_private.h"
44 #include "archive_write_private.h"
45
46 struct ustar {
47         uint64_t        entry_bytes_remaining;
48         uint64_t        entry_padding;
49 };
50
51 /*
52  * Define structure of POSIX 'ustar' tar header.
53  */
54 #define USTAR_name_offset 0
55 #define USTAR_name_size 100
56 #define USTAR_mode_offset 100
57 #define USTAR_mode_size 6
58 #define USTAR_mode_max_size 8
59 #define USTAR_uid_offset 108
60 #define USTAR_uid_size 6
61 #define USTAR_uid_max_size 8
62 #define USTAR_gid_offset 116
63 #define USTAR_gid_size 6
64 #define USTAR_gid_max_size 8
65 #define USTAR_size_offset 124
66 #define USTAR_size_size 11
67 #define USTAR_size_max_size 12
68 #define USTAR_mtime_offset 136
69 #define USTAR_mtime_size 11
70 #define USTAR_mtime_max_size 11
71 #define USTAR_checksum_offset 148
72 #define USTAR_checksum_size 8
73 #define USTAR_typeflag_offset 156
74 #define USTAR_typeflag_size 1
75 #define USTAR_linkname_offset 157
76 #define USTAR_linkname_size 100
77 #define USTAR_magic_offset 257
78 #define USTAR_magic_size 6
79 #define USTAR_version_offset 263
80 #define USTAR_version_size 2
81 #define USTAR_uname_offset 265
82 #define USTAR_uname_size 32
83 #define USTAR_gname_offset 297
84 #define USTAR_gname_size 32
85 #define USTAR_rdevmajor_offset 329
86 #define USTAR_rdevmajor_size 6
87 #define USTAR_rdevmajor_max_size 8
88 #define USTAR_rdevminor_offset 337
89 #define USTAR_rdevminor_size 6
90 #define USTAR_rdevminor_max_size 8
91 #define USTAR_prefix_offset 345
92 #define USTAR_prefix_size 155
93 #define USTAR_padding_offset 500
94 #define USTAR_padding_size 12
95
96 /*
97  * A filled-in copy of the header for initialization.
98  */
99 static const char template_header[] = {
100         /* name: 100 bytes */
101         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
102         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
103         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
104         0,0,0,0,
105         /* Mode, space-null termination: 8 bytes */
106         '0','0','0','0','0','0', ' ','\0',
107         /* uid, space-null termination: 8 bytes */
108         '0','0','0','0','0','0', ' ','\0',
109         /* gid, space-null termination: 8 bytes */
110         '0','0','0','0','0','0', ' ','\0',
111         /* size, space termation: 12 bytes */
112         '0','0','0','0','0','0','0','0','0','0','0', ' ',
113         /* mtime, space termation: 12 bytes */
114         '0','0','0','0','0','0','0','0','0','0','0', ' ',
115         /* Initial checksum value: 8 spaces */
116         ' ',' ',' ',' ',' ',' ',' ',' ',
117         /* Typeflag: 1 byte */
118         '0',                    /* '0' = regular file */
119         /* Linkname: 100 bytes */
120         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
121         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
122         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
123         0,0,0,0,
124         /* Magic: 6 bytes, Version: 2 bytes */
125         'u','s','t','a','r','\0', '0','0',
126         /* Uname: 32 bytes */
127         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
128         /* Gname: 32 bytes */
129         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
130         /* rdevmajor + space/null padding: 8 bytes */
131         '0','0','0','0','0','0', ' ','\0',
132         /* rdevminor + space/null padding: 8 bytes */
133         '0','0','0','0','0','0', ' ','\0',
134         /* Prefix: 155 bytes */
135         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
136         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
137         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
138         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0,
139         0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,0,0,0,0,0, 0,0,0,
140         /* Padding: 12 bytes */
141         0,0,0,0,0,0,0,0, 0,0,0,0
142 };
143
144 static ssize_t  archive_write_ustar_data(struct archive_write *a, const void *buff,
145                     size_t s);
146 static int      archive_write_ustar_destroy(struct archive_write *);
147 static int      archive_write_ustar_finish(struct archive_write *);
148 static int      archive_write_ustar_finish_entry(struct archive_write *);
149 static int      archive_write_ustar_header(struct archive_write *,
150                     struct archive_entry *entry);
151 static int      format_256(int64_t, char *, int);
152 static int      format_number(int64_t, char *, int size, int max, int strict);
153 static int      format_octal(int64_t, char *, int);
154 static int      write_nulls(struct archive_write *a, size_t);
155
156 /*
157  * Set output format to 'ustar' format.
158  */
159 int
160 archive_write_set_format_ustar(struct archive *_a)
161 {
162         struct archive_write *a = (struct archive_write *)_a;
163         struct ustar *ustar;
164
165         /* If someone else was already registered, unregister them. */
166         if (a->format_destroy != NULL)
167                 (a->format_destroy)(a);
168
169         /* Basic internal sanity test. */
170         if (sizeof(template_header) != 512) {
171                 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC, "Internal: template_header wrong size: %d should be 512", sizeof(template_header));
172                 return (ARCHIVE_FATAL);
173         }
174
175         ustar = (struct ustar *)malloc(sizeof(*ustar));
176         if (ustar == NULL) {
177                 archive_set_error(&a->archive, ENOMEM, "Can't allocate ustar data");
178                 return (ARCHIVE_FATAL);
179         }
180         memset(ustar, 0, sizeof(*ustar));
181         a->format_data = ustar;
182
183         a->pad_uncompressed = 1;        /* Mimic gtar in this respect. */
184         a->format_write_header = archive_write_ustar_header;
185         a->format_write_data = archive_write_ustar_data;
186         a->format_finish = archive_write_ustar_finish;
187         a->format_destroy = archive_write_ustar_destroy;
188         a->format_finish_entry = archive_write_ustar_finish_entry;
189         a->archive_format = ARCHIVE_FORMAT_TAR_USTAR;
190         a->archive_format_name = "POSIX ustar";
191         return (ARCHIVE_OK);
192 }
193
194 static int
195 archive_write_ustar_header(struct archive_write *a, struct archive_entry *entry)
196 {
197         char buff[512];
198         int ret;
199         struct ustar *ustar;
200
201         ustar = (struct ustar *)a->format_data;
202
203         /* Only regular files (not hardlinks) have data. */
204         if (archive_entry_hardlink(entry) != NULL ||
205             archive_entry_symlink(entry) != NULL ||
206             !(archive_entry_filetype(entry) == AE_IFREG))
207                 archive_entry_set_size(entry, 0);
208
209         if (AE_IFDIR == archive_entry_mode(entry)) {
210                 const char *p;
211                 char *t;
212                 /*
213                  * Ensure a trailing '/'.  Modify the entry so
214                  * the client sees the change.
215                  */
216                 p = archive_entry_pathname(entry);
217                 if (p[strlen(p) - 1] != '/') {
218                         t = (char *)malloc(strlen(p) + 2);
219                         if (t != NULL) {
220                                 strcpy(t, p);
221                                 strcat(t, "/");
222                                 archive_entry_copy_pathname(entry, t);
223                                 free(t);
224                         }
225                 }
226         }
227
228         ret = __archive_write_format_header_ustar(a, buff, entry, -1, 1);
229         if (ret != ARCHIVE_OK)
230                 return (ret);
231         ret = (a->compressor.write)(a, buff, 512);
232         if (ret != ARCHIVE_OK)
233                 return (ret);
234
235         ustar->entry_bytes_remaining = archive_entry_size(entry);
236         ustar->entry_padding = 0x1ff & (-(int64_t)ustar->entry_bytes_remaining);
237         return (ARCHIVE_OK);
238 }
239
240 /*
241  * Format a basic 512-byte "ustar" header.
242  *
243  * Returns -1 if format failed (due to field overflow).
244  * Note that this always formats as much of the header as possible.
245  * If "strict" is set to zero, it will extend numeric fields as
246  * necessary (overwriting terminators or using base-256 extensions).
247  *
248  * This is exported so that other 'tar' formats can use it.
249  */
250 int
251 __archive_write_format_header_ustar(struct archive_write *a, char h[512],
252     struct archive_entry *entry, int tartype, int strict)
253 {
254         unsigned int checksum;
255         int i, ret;
256         size_t copy_length;
257         const char *p, *pp;
258         int mytartype;
259
260         ret = 0;
261         mytartype = -1;
262         /*
263          * The "template header" already includes the "ustar"
264          * signature, various end-of-field markers and other required
265          * elements.
266          */
267         memcpy(h, &template_header, 512);
268
269         /*
270          * Because the block is already null-filled, and strings
271          * are allowed to exactly fill their destination (without null),
272          * I use memcpy(dest, src, strlen()) here a lot to copy strings.
273          */
274
275         pp = archive_entry_pathname(entry);
276         if (strlen(pp) <= USTAR_name_size)
277                 memcpy(h + USTAR_name_offset, pp, strlen(pp));
278         else {
279                 /* Store in two pieces, splitting at a '/'. */
280                 p = strchr(pp + strlen(pp) - USTAR_name_size - 1, '/');
281                 /*
282                  * If the separator we found is the first '/', find
283                  * the next one.  (This is a pathological case that
284                  * occurs for paths of exactly 101 bytes that start with
285                  * '/'; it occurs because the separating '/' is not
286                  * stored explicitly and the reconstruction assumes that
287                  * an empty prefix means there is no '/' separator.)
288                  */
289                 if (p == pp)
290                         p = strchr(p + 1, '/');
291                 /*
292                  * If there is no path separator, or the prefix or
293                  * remaining name are too large, return an error.
294                  */
295                 if (!p) {
296                         archive_set_error(&a->archive, ENAMETOOLONG,
297                             "Pathname too long");
298                         ret = ARCHIVE_WARN;
299                 } else if (p  > pp + USTAR_prefix_size) {
300                         archive_set_error(&a->archive, ENAMETOOLONG,
301                             "Pathname too long");
302                         ret = ARCHIVE_WARN;
303                 } else {
304                         /* Copy prefix and remainder to appropriate places */
305                         memcpy(h + USTAR_prefix_offset, pp, p - pp);
306                         memcpy(h + USTAR_name_offset, p + 1, pp + strlen(pp) - p - 1);
307                 }
308         }
309
310         p = archive_entry_hardlink(entry);
311         if (p != NULL)
312                 mytartype = '1';
313         else
314                 p = archive_entry_symlink(entry);
315         if (p != NULL && p[0] != '\0') {
316                 copy_length = strlen(p);
317                 if (copy_length > USTAR_linkname_size) {
318                         archive_set_error(&a->archive, ENAMETOOLONG,
319                             "Link contents too long");
320                         ret = ARCHIVE_WARN;
321                         copy_length = USTAR_linkname_size;
322                 }
323                 memcpy(h + USTAR_linkname_offset, p, copy_length);
324         }
325
326         p = archive_entry_uname(entry);
327         if (p != NULL && p[0] != '\0') {
328                 copy_length = strlen(p);
329                 if (copy_length > USTAR_uname_size) {
330                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
331                             "Username too long");
332                         ret = ARCHIVE_WARN;
333                         copy_length = USTAR_uname_size;
334                 }
335                 memcpy(h + USTAR_uname_offset, p, copy_length);
336         }
337
338         p = archive_entry_gname(entry);
339         if (p != NULL && p[0] != '\0') {
340                 copy_length = strlen(p);
341                 if (strlen(p) > USTAR_gname_size) {
342                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
343                             "Group name too long");
344                         ret = ARCHIVE_WARN;
345                         copy_length = USTAR_gname_size;
346                 }
347                 memcpy(h + USTAR_gname_offset, p, copy_length);
348         }
349
350         if (format_number(archive_entry_mode(entry) & 07777, h + USTAR_mode_offset, USTAR_mode_size, USTAR_mode_max_size, strict)) {
351                 archive_set_error(&a->archive, ERANGE, "Numeric mode too large");
352                 ret = ARCHIVE_WARN;
353         }
354
355         if (format_number(archive_entry_uid(entry), h + USTAR_uid_offset, USTAR_uid_size, USTAR_uid_max_size, strict)) {
356                 archive_set_error(&a->archive, ERANGE, "Numeric user ID too large");
357                 ret = ARCHIVE_WARN;
358         }
359
360         if (format_number(archive_entry_gid(entry), h + USTAR_gid_offset, USTAR_gid_size, USTAR_gid_max_size, strict)) {
361                 archive_set_error(&a->archive, ERANGE, "Numeric group ID too large");
362                 ret = ARCHIVE_WARN;
363         }
364
365         if (format_number(archive_entry_size(entry), h + USTAR_size_offset, USTAR_size_size, USTAR_size_max_size, strict)) {
366                 archive_set_error(&a->archive, ERANGE, "File size out of range");
367                 ret = ARCHIVE_WARN;
368         }
369
370         if (format_number(archive_entry_mtime(entry), h + USTAR_mtime_offset, USTAR_mtime_size, USTAR_mtime_max_size, strict)) {
371                 archive_set_error(&a->archive, ERANGE,
372                     "File modification time too large");
373                 ret = ARCHIVE_WARN;
374         }
375
376         if (archive_entry_filetype(entry) == AE_IFBLK
377             || archive_entry_filetype(entry) == AE_IFCHR) {
378                 if (format_number(archive_entry_rdevmajor(entry), h + USTAR_rdevmajor_offset,
379                         USTAR_rdevmajor_size, USTAR_rdevmajor_max_size, strict)) {
380                         archive_set_error(&a->archive, ERANGE,
381                             "Major device number too large");
382                         ret = ARCHIVE_WARN;
383                 }
384
385                 if (format_number(archive_entry_rdevminor(entry), h + USTAR_rdevminor_offset,
386                         USTAR_rdevminor_size, USTAR_rdevminor_max_size, strict)) {
387                         archive_set_error(&a->archive, ERANGE,
388                             "Minor device number too large");
389                         ret = ARCHIVE_WARN;
390                 }
391         }
392
393         if (tartype >= 0) {
394                 h[USTAR_typeflag_offset] = tartype;
395         } else if (mytartype >= 0) {
396                 h[USTAR_typeflag_offset] = mytartype;
397         } else {
398                 switch (archive_entry_filetype(entry)) {
399                 case AE_IFREG: h[USTAR_typeflag_offset] = '0' ; break;
400                 case AE_IFLNK: h[USTAR_typeflag_offset] = '2' ; break;
401                 case AE_IFCHR: h[USTAR_typeflag_offset] = '3' ; break;
402                 case AE_IFBLK: h[USTAR_typeflag_offset] = '4' ; break;
403                 case AE_IFDIR: h[USTAR_typeflag_offset] = '5' ; break;
404                 case AE_IFIFO: h[USTAR_typeflag_offset] = '6' ; break;
405                 default:
406                         archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
407                             "tar format cannot archive this (mode=0%lo)",
408                             (unsigned long)archive_entry_mode(entry));
409                         ret = ARCHIVE_WARN;
410                 }
411         }
412
413         checksum = 0;
414         for (i = 0; i < 512; i++)
415                 checksum += 255 & (unsigned int)h[i];
416         h[USTAR_checksum_offset + 6] = '\0'; /* Can't be pre-set in the template. */
417         /* h[USTAR_checksum_offset + 7] = ' '; */ /* This is pre-set in the template. */
418         format_octal(checksum, h + USTAR_checksum_offset, 6);
419         return (ret);
420 }
421
422 /*
423  * Format a number into a field, with some intelligence.
424  */
425 static int
426 format_number(int64_t v, char *p, int s, int maxsize, int strict)
427 {
428         int64_t limit;
429
430         limit = ((int64_t)1 << (s*3));
431
432         /* "Strict" only permits octal values with proper termination. */
433         if (strict)
434                 return (format_octal(v, p, s));
435
436         /*
437          * In non-strict mode, we allow the number to overwrite one or
438          * more bytes of the field termination.  Even old tar
439          * implementations should be able to handle this with no
440          * problem.
441          */
442         if (v >= 0) {
443                 while (s <= maxsize) {
444                         if (v < limit)
445                                 return (format_octal(v, p, s));
446                         s++;
447                         limit <<= 3;
448                 }
449         }
450
451         /* Base-256 can handle any number, positive or negative. */
452         return (format_256(v, p, maxsize));
453 }
454
455 /*
456  * Format a number into the specified field using base-256.
457  */
458 static int
459 format_256(int64_t v, char *p, int s)
460 {
461         p += s;
462         while (s-- > 0) {
463                 *--p = (char)(v & 0xff);
464                 v >>= 8;
465         }
466         *p |= 0x80; /* Set the base-256 marker bit. */
467         return (0);
468 }
469
470 /*
471  * Format a number into the specified field.
472  */
473 static int
474 format_octal(int64_t v, char *p, int s)
475 {
476         int len;
477
478         len = s;
479
480         /* Octal values can't be negative, so use 0. */
481         if (v < 0) {
482                 while (len-- > 0)
483                         *p++ = '0';
484                 return (-1);
485         }
486
487         p += s;         /* Start at the end and work backwards. */
488         while (s-- > 0) {
489                 *--p = (char)('0' + (v & 7));
490                 v >>= 3;
491         }
492
493         if (v == 0)
494                 return (0);
495
496         /* If it overflowed, fill field with max value. */
497         while (len-- > 0)
498                 *p++ = '7';
499
500         return (-1);
501 }
502
503 static int
504 archive_write_ustar_finish(struct archive_write *a)
505 {
506         int r;
507
508         if (a->compressor.write == NULL)
509                 return (ARCHIVE_OK);
510
511         r = write_nulls(a, 512*2);
512         return (r);
513 }
514
515 static int
516 archive_write_ustar_destroy(struct archive_write *a)
517 {
518         struct ustar *ustar;
519
520         ustar = (struct ustar *)a->format_data;
521         free(ustar);
522         a->format_data = NULL;
523         return (ARCHIVE_OK);
524 }
525
526 static int
527 archive_write_ustar_finish_entry(struct archive_write *a)
528 {
529         struct ustar *ustar;
530         int ret;
531
532         ustar = (struct ustar *)a->format_data;
533         ret = write_nulls(a,
534             ustar->entry_bytes_remaining + ustar->entry_padding);
535         ustar->entry_bytes_remaining = ustar->entry_padding = 0;
536         return (ret);
537 }
538
539 static int
540 write_nulls(struct archive_write *a, size_t padding)
541 {
542         int ret;
543         size_t to_write;
544
545         while (padding > 0) {
546                 to_write = padding < a->null_length ? padding : a->null_length;
547                 ret = (a->compressor.write)(a, a->nulls, to_write);
548                 if (ret != ARCHIVE_OK)
549                         return (ret);
550                 padding -= to_write;
551         }
552         return (ARCHIVE_OK);
553 }
554
555 static ssize_t
556 archive_write_ustar_data(struct archive_write *a, const void *buff, size_t s)
557 {
558         struct ustar *ustar;
559         int ret;
560
561         ustar = (struct ustar *)a->format_data;
562         if (s > ustar->entry_bytes_remaining)
563                 s = ustar->entry_bytes_remaining;
564         ret = (a->compressor.write)(a, buff, s);
565         ustar->entry_bytes_remaining -= s;
566         if (ret != ARCHIVE_OK)
567                 return (ret);
568         return (s);
569 }