2 * Copyright (c) 2003-2007 Tim Kientzle
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
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 $");
42 #include "archive_entry.h"
43 #include "archive_private.h"
44 #include "archive_write_private.h"
47 uint64_t entry_bytes_remaining;
48 uint64_t entry_padding;
52 * Define structure of POSIX 'ustar' tar header.
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
97 * A filled-in copy of the header for initialization.
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,
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,
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
144 static ssize_t archive_write_ustar_data(struct archive_write *a, const void *buff,
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);
157 * Set output format to 'ustar' format.
160 archive_write_set_format_ustar(struct archive *_a)
162 struct archive_write *a = (struct archive_write *)_a;
165 /* If someone else was already registered, unregister them. */
166 if (a->format_destroy != NULL)
167 (a->format_destroy)(a);
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);
175 ustar = (struct ustar *)malloc(sizeof(*ustar));
177 archive_set_error(&a->archive, ENOMEM, "Can't allocate ustar data");
178 return (ARCHIVE_FATAL);
180 memset(ustar, 0, sizeof(*ustar));
181 a->format_data = ustar;
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";
195 archive_write_ustar_header(struct archive_write *a, struct archive_entry *entry)
201 ustar = (struct ustar *)a->format_data;
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);
209 if (AE_IFDIR == archive_entry_mode(entry)) {
213 * Ensure a trailing '/'. Modify the entry so
214 * the client sees the change.
216 p = archive_entry_pathname(entry);
217 if (p[strlen(p) - 1] != '/') {
218 t = (char *)malloc(strlen(p) + 2);
220 archive_set_error(&a->archive, ENOMEM,
221 "Can't allocate ustar data");
222 return(ARCHIVE_FATAL);
226 archive_entry_copy_pathname(entry, t);
231 ret = __archive_write_format_header_ustar(a, buff, entry, -1, 1);
232 if (ret != ARCHIVE_OK)
234 ret = (a->compressor.write)(a, buff, 512);
235 if (ret != ARCHIVE_OK)
238 ustar->entry_bytes_remaining = archive_entry_size(entry);
239 ustar->entry_padding = 0x1ff & (-(int64_t)ustar->entry_bytes_remaining);
244 * Format a basic 512-byte "ustar" header.
246 * Returns -1 if format failed (due to field overflow).
247 * Note that this always formats as much of the header as possible.
248 * If "strict" is set to zero, it will extend numeric fields as
249 * necessary (overwriting terminators or using base-256 extensions).
251 * This is exported so that other 'tar' formats can use it.
254 __archive_write_format_header_ustar(struct archive_write *a, char h[512],
255 struct archive_entry *entry, int tartype, int strict)
257 unsigned int checksum;
266 * The "template header" already includes the "ustar"
267 * signature, various end-of-field markers and other required
270 memcpy(h, &template_header, 512);
273 * Because the block is already null-filled, and strings
274 * are allowed to exactly fill their destination (without null),
275 * I use memcpy(dest, src, strlen()) here a lot to copy strings.
278 pp = archive_entry_pathname(entry);
279 if (strlen(pp) <= USTAR_name_size)
280 memcpy(h + USTAR_name_offset, pp, strlen(pp));
282 /* Store in two pieces, splitting at a '/'. */
283 p = strchr(pp + strlen(pp) - USTAR_name_size - 1, '/');
285 * If the separator we found is the first '/', find
286 * the next one. (This is a pathological case that
287 * occurs for paths of exactly 101 bytes that start with
288 * '/'; it occurs because the separating '/' is not
289 * stored explicitly and the reconstruction assumes that
290 * an empty prefix means there is no '/' separator.)
293 p = strchr(p + 1, '/');
295 * If there is no path separator, or the prefix or
296 * remaining name are too large, return an error.
299 archive_set_error(&a->archive, ENAMETOOLONG,
300 "Pathname too long");
302 } else if (p > pp + USTAR_prefix_size) {
303 archive_set_error(&a->archive, ENAMETOOLONG,
304 "Pathname too long");
307 /* Copy prefix and remainder to appropriate places */
308 memcpy(h + USTAR_prefix_offset, pp, p - pp);
309 memcpy(h + USTAR_name_offset, p + 1, pp + strlen(pp) - p - 1);
313 p = archive_entry_hardlink(entry);
317 p = archive_entry_symlink(entry);
318 if (p != NULL && p[0] != '\0') {
319 copy_length = strlen(p);
320 if (copy_length > USTAR_linkname_size) {
321 archive_set_error(&a->archive, ENAMETOOLONG,
322 "Link contents too long");
324 copy_length = USTAR_linkname_size;
326 memcpy(h + USTAR_linkname_offset, p, copy_length);
329 p = archive_entry_uname(entry);
330 if (p != NULL && p[0] != '\0') {
331 copy_length = strlen(p);
332 if (copy_length > USTAR_uname_size) {
333 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
334 "Username too long");
336 copy_length = USTAR_uname_size;
338 memcpy(h + USTAR_uname_offset, p, copy_length);
341 p = archive_entry_gname(entry);
342 if (p != NULL && p[0] != '\0') {
343 copy_length = strlen(p);
344 if (strlen(p) > USTAR_gname_size) {
345 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
346 "Group name too long");
348 copy_length = USTAR_gname_size;
350 memcpy(h + USTAR_gname_offset, p, copy_length);
353 if (format_number(archive_entry_mode(entry) & 07777, h + USTAR_mode_offset, USTAR_mode_size, USTAR_mode_max_size, strict)) {
354 archive_set_error(&a->archive, ERANGE, "Numeric mode too large");
358 if (format_number(archive_entry_uid(entry), h + USTAR_uid_offset, USTAR_uid_size, USTAR_uid_max_size, strict)) {
359 archive_set_error(&a->archive, ERANGE, "Numeric user ID too large");
363 if (format_number(archive_entry_gid(entry), h + USTAR_gid_offset, USTAR_gid_size, USTAR_gid_max_size, strict)) {
364 archive_set_error(&a->archive, ERANGE, "Numeric group ID too large");
368 if (format_number(archive_entry_size(entry), h + USTAR_size_offset, USTAR_size_size, USTAR_size_max_size, strict)) {
369 archive_set_error(&a->archive, ERANGE, "File size out of range");
373 if (format_number(archive_entry_mtime(entry), h + USTAR_mtime_offset, USTAR_mtime_size, USTAR_mtime_max_size, strict)) {
374 archive_set_error(&a->archive, ERANGE,
375 "File modification time too large");
379 if (archive_entry_filetype(entry) == AE_IFBLK
380 || archive_entry_filetype(entry) == AE_IFCHR) {
381 if (format_number(archive_entry_rdevmajor(entry), h + USTAR_rdevmajor_offset,
382 USTAR_rdevmajor_size, USTAR_rdevmajor_max_size, strict)) {
383 archive_set_error(&a->archive, ERANGE,
384 "Major device number too large");
388 if (format_number(archive_entry_rdevminor(entry), h + USTAR_rdevminor_offset,
389 USTAR_rdevminor_size, USTAR_rdevminor_max_size, strict)) {
390 archive_set_error(&a->archive, ERANGE,
391 "Minor device number too large");
397 h[USTAR_typeflag_offset] = tartype;
398 } else if (mytartype >= 0) {
399 h[USTAR_typeflag_offset] = mytartype;
401 switch (archive_entry_filetype(entry)) {
402 case AE_IFREG: h[USTAR_typeflag_offset] = '0' ; break;
403 case AE_IFLNK: h[USTAR_typeflag_offset] = '2' ; break;
404 case AE_IFCHR: h[USTAR_typeflag_offset] = '3' ; break;
405 case AE_IFBLK: h[USTAR_typeflag_offset] = '4' ; break;
406 case AE_IFDIR: h[USTAR_typeflag_offset] = '5' ; break;
407 case AE_IFIFO: h[USTAR_typeflag_offset] = '6' ; break;
409 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
410 "tar format cannot archive this (mode=0%lo)",
411 (unsigned long)archive_entry_mode(entry));
417 for (i = 0; i < 512; i++)
418 checksum += 255 & (unsigned int)h[i];
419 h[USTAR_checksum_offset + 6] = '\0'; /* Can't be pre-set in the template. */
420 /* h[USTAR_checksum_offset + 7] = ' '; */ /* This is pre-set in the template. */
421 format_octal(checksum, h + USTAR_checksum_offset, 6);
426 * Format a number into a field, with some intelligence.
429 format_number(int64_t v, char *p, int s, int maxsize, int strict)
433 limit = ((int64_t)1 << (s*3));
435 /* "Strict" only permits octal values with proper termination. */
437 return (format_octal(v, p, s));
440 * In non-strict mode, we allow the number to overwrite one or
441 * more bytes of the field termination. Even old tar
442 * implementations should be able to handle this with no
446 while (s <= maxsize) {
448 return (format_octal(v, p, s));
454 /* Base-256 can handle any number, positive or negative. */
455 return (format_256(v, p, maxsize));
459 * Format a number into the specified field using base-256.
462 format_256(int64_t v, char *p, int s)
466 *--p = (char)(v & 0xff);
469 *p |= 0x80; /* Set the base-256 marker bit. */
474 * Format a number into the specified field.
477 format_octal(int64_t v, char *p, int s)
483 /* Octal values can't be negative, so use 0. */
490 p += s; /* Start at the end and work backwards. */
492 *--p = (char)('0' + (v & 7));
499 /* If it overflowed, fill field with max value. */
507 archive_write_ustar_finish(struct archive_write *a)
511 if (a->compressor.write == NULL)
514 r = write_nulls(a, 512*2);
519 archive_write_ustar_destroy(struct archive_write *a)
523 ustar = (struct ustar *)a->format_data;
525 a->format_data = NULL;
530 archive_write_ustar_finish_entry(struct archive_write *a)
535 ustar = (struct ustar *)a->format_data;
537 ustar->entry_bytes_remaining + ustar->entry_padding);
538 ustar->entry_bytes_remaining = ustar->entry_padding = 0;
543 write_nulls(struct archive_write *a, size_t padding)
548 while (padding > 0) {
549 to_write = padding < a->null_length ? padding : a->null_length;
550 ret = (a->compressor.write)(a, a->nulls, to_write);
551 if (ret != ARCHIVE_OK)
559 archive_write_ustar_data(struct archive_write *a, const void *buff, size_t s)
564 ustar = (struct ustar *)a->format_data;
565 if (s > ustar->entry_bytes_remaining)
566 s = ustar->entry_bytes_remaining;
567 ret = (a->compressor.write)(a, buff, s);
568 ustar->entry_bytes_remaining -= s;
569 if (ret != ARCHIVE_OK)