contrib/libarchive/libarchive/archive_write_set_format_ustar.c

   1 /*-
   2  * Copyright (c) 2003-2007 Tim Kientzle
   3  * Copyright (c) 2011-2012 Michihiro NAKAJIMA
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18  * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
  19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #include "archive_platform.h"
  28 __FBSDID("$FreeBSD$");
  29
  30
  31 #ifdef HAVE_ERRNO_H
  32 #include <errno.h>
  33 #endif
  34 #include <stdio.h>
  35 #ifdef HAVE_STDLIB_H
  36 #include <stdlib.h>
  37 #endif
  38 #ifdef HAVE_STRING_H
  39 #include <string.h>
  40 #endif
  41
  42 #include "archive.h"
  43 #include "archive_entry.h"
  44 #include "archive_entry_locale.h"
  45 #include "archive_private.h"
  46 #include "archive_write_private.h"
  47
  48 struct ustar {
  49         uint64_t        entry_bytes_remaining;
  50         uint64_t        entry_padding;
  51
  52         struct archive_string_conv *opt_sconv;
  53         struct archive_string_conv *sconv_default;
  54         int     init_default_conversion;
  55 };
  56
  57 /*
  58  * Define structure of POSIX 'ustar' tar header.
  59  */
  60 #define USTAR_name_offset 0
  61 #define USTAR_name_size 100
  62 #define USTAR_mode_offset 100
  63 #define USTAR_mode_size 6
  64 #define USTAR_mode_max_size 8
  65 #define USTAR_uid_offset 108
  66 #define USTAR_uid_size 6
  67 #define USTAR_uid_max_size 8
  68 #define USTAR_gid_offset 116
  69 #define USTAR_gid_size 6
  70 #define USTAR_gid_max_size 8
  71 #define USTAR_size_offset 124
  72 #define USTAR_size_size 11
  73 #define USTAR_size_max_size 12
  74 #define USTAR_mtime_offset 136
  75 #define USTAR_mtime_size 11
  76 #define USTAR_mtime_max_size 11
  77 #define USTAR_checksum_offset 148
  78 #define USTAR_checksum_size 8
  79 #define USTAR_typeflag_offset 156
  80 #define USTAR_typeflag_size 1
  81 #define USTAR_linkname_offset 157
  82 #define USTAR_linkname_size 100
  83 #define USTAR_magic_offset 257
  84 #define USTAR_magic_size 6
  85 #define USTAR_version_offset 263
  86 #define USTAR_version_size 2
  87 #define USTAR_uname_offset 265
  88 #define USTAR_uname_size 32
  89 #define USTAR_gname_offset 297
  90 #define USTAR_gname_size 32
  91 #define USTAR_rdevmajor_offset 329
  92 #define USTAR_rdevmajor_size 6
  93 #define USTAR_rdevmajor_max_size 8
  94 #define USTAR_rdevminor_offset 337
  95 #define USTAR_rdevminor_size 6
  96 #define USTAR_rdevminor_max_size 8
  97 #define USTAR_prefix_offset 345
  98 #define USTAR_prefix_size 155
  99 #define USTAR_padding_offset 500
 100 #define USTAR_padding_size 12
 101
 102 /*
 103  * A filled-in copy of the header for initialization.
 104  */
 105 static const char template_header[] = {
 106         /* name: 100 bytes */
 107         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,
 108         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,
 109         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,
 110         0,0,0,0,
 111         /* Mode, space-null termination: 8 bytes */
 112         '0','0','0','0','0','0', ' ','\0',
 113         /* uid, space-null termination: 8 bytes */
 114         '0','0','0','0','0','0', ' ','\0',
 115         /* gid, space-null termination: 8 bytes */
 116         '0','0','0','0','0','0', ' ','\0',
 117         /* size, space termination: 12 bytes */
 118         '0','0','0','0','0','0','0','0','0','0','0', ' ',
 119         /* mtime, space termination: 12 bytes */
 120         '0','0','0','0','0','0','0','0','0','0','0', ' ',
 121         /* Initial checksum value: 8 spaces */
 122         ' ',' ',' ',' ',' ',' ',' ',' ',
 123         /* Typeflag: 1 byte */
 124         '0',                    /* '0' = regular file */
 125         /* Linkname: 100 bytes */
 126         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,
 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         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,
 129         0,0,0,0,
 130         /* Magic: 6 bytes, Version: 2 bytes */
 131         'u','s','t','a','r','\0', '0','0',
 132         /* Uname: 32 bytes */
 133         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,
 134         /* Gname: 32 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         /* rdevmajor + space/null padding: 8 bytes */
 137         '0','0','0','0','0','0', ' ','\0',
 138         /* rdevminor + space/null padding: 8 bytes */
 139         '0','0','0','0','0','0', ' ','\0',
 140         /* Prefix: 155 bytes */
 141         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,
 142         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,
 143         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,
 144         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,
 145         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,
 146         /* Padding: 12 bytes */
 147         0,0,0,0,0,0,0,0, 0,0,0,0
 148 };
 149
 150 static ssize_t  archive_write_ustar_data(struct archive_write *a, const void *buff,
 151                     size_t s);
 152 static int      archive_write_ustar_free(struct archive_write *);
 153 static int      archive_write_ustar_close(struct archive_write *);
 154 static int      archive_write_ustar_finish_entry(struct archive_write *);
 155 static int      archive_write_ustar_header(struct archive_write *,
 156                     struct archive_entry *entry);
 157 static int      archive_write_ustar_options(struct archive_write *,
 158                     const char *, const char *);
 159 static int      format_256(int64_t, char *, int);
 160 static int      format_number(int64_t, char *, int size, int max, int strict);
 161 static int      format_octal(int64_t, char *, int);
 162
 163 /*
 164  * Set output format to 'ustar' format.
 165  */
 166 int
 167 archive_write_set_format_ustar(struct archive *_a)
 168 {
 169         struct archive_write *a = (struct archive_write *)_a;
 170         struct ustar *ustar;
 171
 172         archive_check_magic(_a, ARCHIVE_WRITE_MAGIC,
 173             ARCHIVE_STATE_NEW, "archive_write_set_format_ustar");
 174
 175         /* If someone else was already registered, unregister them. */
 176         if (a->format_free != NULL)
 177                 (a->format_free)(a);
 178
 179         /* Basic internal sanity test. */
 180         if (sizeof(template_header) != 512) {
 181                 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
 182                     "Internal: template_header wrong size: %zu should be 512",
 183                     sizeof(template_header));
 184                 return (ARCHIVE_FATAL);
 185         }
 186
 187         ustar = (struct ustar *)calloc(1, sizeof(*ustar));
 188         if (ustar == NULL) {
 189                 archive_set_error(&a->archive, ENOMEM,
 190                     "Can't allocate ustar data");
 191                 return (ARCHIVE_FATAL);
 192         }
 193         a->format_data = ustar;
 194         a->format_name = "ustar";
 195         a->format_options = archive_write_ustar_options;
 196         a->format_write_header = archive_write_ustar_header;
 197         a->format_write_data = archive_write_ustar_data;
 198         a->format_close = archive_write_ustar_close;
 199         a->format_free = archive_write_ustar_free;
 200         a->format_finish_entry = archive_write_ustar_finish_entry;
 201         a->archive.archive_format = ARCHIVE_FORMAT_TAR_USTAR;
 202         a->archive.archive_format_name = "POSIX ustar";
 203         return (ARCHIVE_OK);
 204 }
 205
 206 static int
 207 archive_write_ustar_options(struct archive_write *a, const char *key,
 208     const char *val)
 209 {
 210         struct ustar *ustar = (struct ustar *)a->format_data;
 211         int ret = ARCHIVE_FAILED;
 212
 213         if (strcmp(key, "hdrcharset")  == 0) {
 214                 if (val == NULL || val[0] == 0)
 215                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
 216                             "%s: hdrcharset option needs a character-set name",
 217                             a->format_name);
 218                 else {
 219                         ustar->opt_sconv = archive_string_conversion_to_charset(
 220                             &a->archive, val, 0);
 221                         if (ustar->opt_sconv != NULL)
 222                                 ret = ARCHIVE_OK;
 223                         else
 224                                 ret = ARCHIVE_FATAL;
 225                 }
 226                 return (ret);
 227         }
 228
 229         /* Note: The "warn" return is just to inform the options
 230          * supervisor that we didn't handle it.  It will generate
 231          * a suitable error if no one used this option. */
 232         return (ARCHIVE_WARN);
 233 }
 234
 235 static int
 236 archive_write_ustar_header(struct archive_write *a, struct archive_entry *entry)
 237 {
 238         char buff[512];
 239         int ret, ret2;
 240         struct ustar *ustar;
 241         struct archive_entry *entry_main;
 242         struct archive_string_conv *sconv;
 243
 244         ustar = (struct ustar *)a->format_data;
 245
 246         /* Setup default string conversion. */
 247         if (ustar->opt_sconv == NULL) {
 248                 if (!ustar->init_default_conversion) {
 249                         ustar->sconv_default =
 250                             archive_string_default_conversion_for_write(&(a->archive));
 251                         ustar->init_default_conversion = 1;
 252                 }
 253                 sconv = ustar->sconv_default;
 254         } else
 255                 sconv = ustar->opt_sconv;
 256
 257         /* Sanity check. */
 258         if (archive_entry_pathname(entry) == NULL) {
 259                 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
 260                     "Can't record entry in tar file without pathname");
 261                 return (ARCHIVE_FAILED);
 262         }
 263
 264         /* Only regular files (not hardlinks) have data. */
 265         if (archive_entry_hardlink(entry) != NULL ||
 266             archive_entry_symlink(entry) != NULL ||
 267             !(archive_entry_filetype(entry) == AE_IFREG))
 268                 archive_entry_set_size(entry, 0);
 269
 270         if (AE_IFDIR == archive_entry_filetype(entry)) {
 271                 const char *p;
 272                 size_t path_length;
 273                 /*
 274                  * Ensure a trailing '/'.  Modify the entry so
 275                  * the client sees the change.
 276                  */
 277 #if defined(_WIN32) && !defined(__CYGWIN__)
 278                 const wchar_t *wp;
 279
 280                 wp = archive_entry_pathname_w(entry);
 281                 if (wp != NULL && wp[wcslen(wp) -1] != L'/') {
 282                         struct archive_wstring ws;
 283
 284                         archive_string_init(&ws);
 285                         path_length = wcslen(wp);
 286                         if (archive_wstring_ensure(&ws,
 287                             path_length + 2) == NULL) {
 288                                 archive_set_error(&a->archive, ENOMEM,
 289                                     "Can't allocate ustar data");
 290                                 archive_wstring_free(&ws);
 291                                 return(ARCHIVE_FATAL);
 292                         }
 293                         /* Should we keep '\' ? */
 294                         if (wp[path_length -1] == L'\\')
 295                                 path_length--;
 296                         archive_wstrncpy(&ws, wp, path_length);
 297                         archive_wstrappend_wchar(&ws, L'/');
 298                         archive_entry_copy_pathname_w(entry, ws.s);
 299                         archive_wstring_free(&ws);
 300                         p = NULL;
 301                 } else
 302 #endif
 303                         p = archive_entry_pathname(entry);
 304                 /*
 305                  * On Windows, this is a backup operation just in
 306                  * case getting WCS failed. On POSIX, this is a
 307                  * normal operation.
 308                  */
 309                 if (p != NULL && p[0] != '\0' && p[strlen(p) - 1] != '/') {
 310                         struct archive_string as;
 311
 312                         archive_string_init(&as);
 313                         path_length = strlen(p);
 314                         if (archive_string_ensure(&as,
 315                             path_length + 2) == NULL) {
 316                                 archive_set_error(&a->archive, ENOMEM,
 317                                     "Can't allocate ustar data");
 318                                 archive_string_free(&as);
 319                                 return(ARCHIVE_FATAL);
 320                         }
 321 #if defined(_WIN32) && !defined(__CYGWIN__)
 322                         /* NOTE: This might break the pathname
 323                          * if the current code page is CP932 and
 324                          * the pathname includes a character '\'
 325                          * as a part of its multibyte pathname. */
 326                         if (p[strlen(p) -1] == '\\')
 327                                 path_length--;
 328                         else
 329 #endif
 330                         archive_strncpy(&as, p, path_length);
 331                         archive_strappend_char(&as, '/');
 332                         archive_entry_copy_pathname(entry, as.s);
 333                         archive_string_free(&as);
 334                 }
 335         }
 336
 337 #if defined(_WIN32) && !defined(__CYGWIN__)
 338         /* Make sure the path separators in pathname, hardlink and symlink
 339          * are all slash '/', not the Windows path separator '\'. */
 340         entry_main = __la_win_entry_in_posix_pathseparator(entry);
 341         if (entry_main == NULL) {
 342                 archive_set_error(&a->archive, ENOMEM,
 343                     "Can't allocate ustar data");
 344                 return(ARCHIVE_FATAL);
 345         }
 346         if (entry != entry_main)
 347                 entry = entry_main;
 348         else
 349                 entry_main = NULL;
 350 #else
 351         entry_main = NULL;
 352 #endif
 353         ret = __archive_write_format_header_ustar(a, buff, entry, -1, 1, sconv);
 354         if (ret < ARCHIVE_WARN) {
 355                 archive_entry_free(entry_main);
 356                 return (ret);
 357         }
 358         ret2 = __archive_write_output(a, buff, 512);
 359         if (ret2 < ARCHIVE_WARN) {
 360                 archive_entry_free(entry_main);
 361                 return (ret2);
 362         }
 363         if (ret2 < ret)
 364                 ret = ret2;
 365
 366         ustar->entry_bytes_remaining = archive_entry_size(entry);
 367         ustar->entry_padding = 0x1ff & (-(int64_t)ustar->entry_bytes_remaining);
 368         archive_entry_free(entry_main);
 369         return (ret);
 370 }
 371
 372 /*
 373  * Format a basic 512-byte "ustar" header.
 374  *
 375  * Returns -1 if format failed (due to field overflow).
 376  * Note that this always formats as much of the header as possible.
 377  * If "strict" is set to zero, it will extend numeric fields as
 378  * necessary (overwriting terminators or using base-256 extensions).
 379  *
 380  * This is exported so that other 'tar' formats can use it.
 381  */
 382 int
 383 __archive_write_format_header_ustar(struct archive_write *a, char h[512],
 384     struct archive_entry *entry, int tartype, int strict,
 385     struct archive_string_conv *sconv)
 386 {
 387         unsigned int checksum;
 388         int i, r, ret;
 389         size_t copy_length;
 390         const char *p, *pp;
 391         int mytartype;
 392
 393         ret = 0;
 394         mytartype = -1;
 395         /*
 396          * The "template header" already includes the "ustar"
 397          * signature, various end-of-field markers and other required
 398          * elements.
 399          */
 400         memcpy(h, &template_header, 512);
 401
 402         /*
 403          * Because the block is already null-filled, and strings
 404          * are allowed to exactly fill their destination (without null),
 405          * I use memcpy(dest, src, strlen()) here a lot to copy strings.
 406          */
 407         r = archive_entry_pathname_l(entry, &pp, &copy_length, sconv);
 408         if (r != 0) {
 409                 if (errno == ENOMEM) {
 410                         archive_set_error(&a->archive, ENOMEM,
 411                             "Can't allocate memory for Pathname");
 412                         return (ARCHIVE_FATAL);
 413                 }
 414                 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
 415                     "Can't translate pathname '%s' to %s",
 416                     pp, archive_string_conversion_charset_name(sconv));
 417                 ret = ARCHIVE_WARN;
 418         }
 419         if (copy_length <= USTAR_name_size)
 420                 memcpy(h + USTAR_name_offset, pp, copy_length);
 421         else {
 422                 /* Store in two pieces, splitting at a '/'. */
 423                 p = strchr(pp + copy_length - USTAR_name_size - 1, '/');
 424                 /*
 425                  * Look for the next '/' if we chose the first character
 426                  * as the separator.  (ustar format doesn't permit
 427                  * an empty prefix.)
 428                  */
 429                 if (p == pp)
 430                         p = strchr(p + 1, '/');
 431                 /* Fail if the name won't fit. */
 432                 if (!p) {
 433                         /* No separator. */
 434                         archive_set_error(&a->archive, ENAMETOOLONG,
 435                             "Pathname too long");
 436                         ret = ARCHIVE_FAILED;
 437                 } else if (p[1] == '\0') {
 438                         /*
 439                          * The only feasible separator is a final '/';
 440                          * this would result in a non-empty prefix and
 441                          * an empty name, which POSIX doesn't
 442                          * explicitly forbid, but it just feels wrong.
 443                          */
 444                         archive_set_error(&a->archive, ENAMETOOLONG,
 445                             "Pathname too long");
 446                         ret = ARCHIVE_FAILED;
 447                 } else if (p  > pp + USTAR_prefix_size) {
 448                         /* Prefix is too long. */
 449                         archive_set_error(&a->archive, ENAMETOOLONG,
 450                             "Pathname too long");
 451                         ret = ARCHIVE_FAILED;
 452                 } else {
 453                         /* Copy prefix and remainder to appropriate places */
 454                         memcpy(h + USTAR_prefix_offset, pp, p - pp);
 455                         memcpy(h + USTAR_name_offset, p + 1,
 456                             pp + copy_length - p - 1);
 457                 }
 458         }
 459
 460         r = archive_entry_hardlink_l(entry, &p, &copy_length, sconv);
 461         if (r != 0) {
 462                 if (errno == ENOMEM) {
 463                         archive_set_error(&a->archive, ENOMEM,
 464                             "Can't allocate memory for Linkname");
 465                         return (ARCHIVE_FATAL);
 466                 }
 467                 archive_set_error(&a->archive,
 468                     ARCHIVE_ERRNO_FILE_FORMAT,
 469                     "Can't translate linkname '%s' to %s",
 470                     p, archive_string_conversion_charset_name(sconv));
 471                 ret = ARCHIVE_WARN;
 472         }
 473         if (copy_length > 0)
 474                 mytartype = '1';
 475         else {
 476                 r = archive_entry_symlink_l(entry, &p, &copy_length, sconv);
 477                 if (r != 0) {
 478                         if (errno == ENOMEM) {
 479                                 archive_set_error(&a->archive, ENOMEM,
 480                                     "Can't allocate memory for Linkname");
 481                                 return (ARCHIVE_FATAL);
 482                         }
 483                         archive_set_error(&a->archive,
 484                             ARCHIVE_ERRNO_FILE_FORMAT,
 485                             "Can't translate linkname '%s' to %s",
 486                             p, archive_string_conversion_charset_name(sconv));
 487                         ret = ARCHIVE_WARN;
 488                 }
 489         }
 490         if (copy_length > 0) {
 491                 if (copy_length > USTAR_linkname_size) {
 492                         archive_set_error(&a->archive, ENAMETOOLONG,
 493                             "Link contents too long");
 494                         ret = ARCHIVE_FAILED;
 495                         copy_length = USTAR_linkname_size;
 496                 }
 497                 memcpy(h + USTAR_linkname_offset, p, copy_length);
 498         }
 499
 500         r = archive_entry_uname_l(entry, &p, &copy_length, sconv);
 501         if (r != 0) {
 502                 if (errno == ENOMEM) {
 503                         archive_set_error(&a->archive, ENOMEM,
 504                             "Can't allocate memory for Uname");
 505                         return (ARCHIVE_FATAL);
 506                 }
 507                 archive_set_error(&a->archive,
 508                     ARCHIVE_ERRNO_FILE_FORMAT,
 509                     "Can't translate uname '%s' to %s",
 510                     p, archive_string_conversion_charset_name(sconv));
 511                 ret = ARCHIVE_WARN;
 512         }
 513         if (copy_length > 0) {
 514                 if (copy_length > USTAR_uname_size) {
 515                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
 516                             "Username too long");
 517                         ret = ARCHIVE_FAILED;
 518                         copy_length = USTAR_uname_size;
 519                 }
 520                 memcpy(h + USTAR_uname_offset, p, copy_length);
 521         }
 522
 523         r = archive_entry_gname_l(entry, &p, &copy_length, sconv);
 524         if (r != 0) {
 525                 if (errno == ENOMEM) {
 526                         archive_set_error(&a->archive, ENOMEM,
 527                             "Can't allocate memory for Gname");
 528                         return (ARCHIVE_FATAL);
 529                 }
 530                 archive_set_error(&a->archive,
 531                     ARCHIVE_ERRNO_FILE_FORMAT,
 532                     "Can't translate gname '%s' to %s",
 533                     p, archive_string_conversion_charset_name(sconv));
 534                 ret = ARCHIVE_WARN;
 535         }
 536         if (copy_length > 0) {
 537                 if (strlen(p) > USTAR_gname_size) {
 538                         archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
 539                             "Group name too long");
 540                         ret = ARCHIVE_FAILED;
 541                         copy_length = USTAR_gname_size;
 542                 }
 543                 memcpy(h + USTAR_gname_offset, p, copy_length);
 544         }
 545
 546         if (format_number(archive_entry_mode(entry) & 07777,
 547             h + USTAR_mode_offset, USTAR_mode_size, USTAR_mode_max_size, strict)) {
 548                 archive_set_error(&a->archive, ERANGE,
 549                     "Numeric mode too large");
 550                 ret = ARCHIVE_FAILED;
 551         }
 552
 553         if (format_number(archive_entry_uid(entry),
 554             h + USTAR_uid_offset, USTAR_uid_size, USTAR_uid_max_size, strict)) {
 555                 archive_set_error(&a->archive, ERANGE,
 556                     "Numeric user ID too large");
 557                 ret = ARCHIVE_FAILED;
 558         }
 559
 560         if (format_number(archive_entry_gid(entry),
 561             h + USTAR_gid_offset, USTAR_gid_size, USTAR_gid_max_size, strict)) {
 562                 archive_set_error(&a->archive, ERANGE,
 563                     "Numeric group ID too large");
 564                 ret = ARCHIVE_FAILED;
 565         }
 566
 567         if (format_number(archive_entry_size(entry),
 568             h + USTAR_size_offset, USTAR_size_size, USTAR_size_max_size, strict)) {
 569                 archive_set_error(&a->archive, ERANGE,
 570                     "File size out of range");
 571                 ret = ARCHIVE_FAILED;
 572         }
 573
 574         if (format_number(archive_entry_mtime(entry),
 575             h + USTAR_mtime_offset, USTAR_mtime_size, USTAR_mtime_max_size, strict)) {
 576                 archive_set_error(&a->archive, ERANGE,
 577                     "File modification time too large");
 578                 ret = ARCHIVE_FAILED;
 579         }
 580
 581         if (archive_entry_filetype(entry) == AE_IFBLK
 582             || archive_entry_filetype(entry) == AE_IFCHR) {
 583                 if (format_number(archive_entry_rdevmajor(entry),
 584                     h + USTAR_rdevmajor_offset, USTAR_rdevmajor_size,
 585                     USTAR_rdevmajor_max_size, strict)) {
 586                         archive_set_error(&a->archive, ERANGE,
 587                             "Major device number too large");
 588                         ret = ARCHIVE_FAILED;
 589                 }
 590
 591                 if (format_number(archive_entry_rdevminor(entry),
 592                     h + USTAR_rdevminor_offset, USTAR_rdevminor_size,
 593                     USTAR_rdevminor_max_size, strict)) {
 594                         archive_set_error(&a->archive, ERANGE,
 595                             "Minor device number too large");
 596                         ret = ARCHIVE_FAILED;
 597                 }
 598         }
 599
 600         if (tartype >= 0) {
 601                 h[USTAR_typeflag_offset] = tartype;
 602         } else if (mytartype >= 0) {
 603                 h[USTAR_typeflag_offset] = mytartype;
 604         } else {
 605                 switch (archive_entry_filetype(entry)) {
 606                 case AE_IFREG: h[USTAR_typeflag_offset] = '0' ; break;
 607                 case AE_IFLNK: h[USTAR_typeflag_offset] = '2' ; break;
 608                 case AE_IFCHR: h[USTAR_typeflag_offset] = '3' ; break;
 609                 case AE_IFBLK: h[USTAR_typeflag_offset] = '4' ; break;
 610                 case AE_IFDIR: h[USTAR_typeflag_offset] = '5' ; break;
 611                 case AE_IFIFO: h[USTAR_typeflag_offset] = '6' ; break;
 612                 case AE_IFSOCK:
 613                         archive_set_error(&a->archive,
 614                             ARCHIVE_ERRNO_FILE_FORMAT,
 615                             "tar format cannot archive socket");
 616                         return (ARCHIVE_FAILED);
 617                 default:
 618                         archive_set_error(&a->archive,
 619                             ARCHIVE_ERRNO_FILE_FORMAT,
 620                             "tar format cannot archive this (mode=0%lo)",
 621                             (unsigned long)archive_entry_mode(entry));
 622                         ret = ARCHIVE_FAILED;
 623                 }
 624         }
 625
 626         checksum = 0;
 627         for (i = 0; i < 512; i++)
 628                 checksum += 255 & (unsigned int)h[i];
 629         h[USTAR_checksum_offset + 6] = '\0'; /* Can't be pre-set in the template. */
 630         /* h[USTAR_checksum_offset + 7] = ' '; */ /* This is pre-set in the template. */
 631         format_octal(checksum, h + USTAR_checksum_offset, 6);
 632         return (ret);
 633 }
 634
 635 /*
 636  * Format a number into a field, with some intelligence.
 637  */
 638 static int
 639 format_number(int64_t v, char *p, int s, int maxsize, int strict)
 640 {
 641         int64_t limit;
 642
 643         limit = ((int64_t)1 << (s*3));
 644
 645         /* "Strict" only permits octal values with proper termination. */
 646         if (strict)
 647                 return (format_octal(v, p, s));
 648
 649         /*
 650          * In non-strict mode, we allow the number to overwrite one or
 651          * more bytes of the field termination.  Even old tar
 652          * implementations should be able to handle this with no
 653          * problem.
 654          */
 655         if (v >= 0) {
 656                 while (s <= maxsize) {
 657                         if (v < limit)
 658                                 return (format_octal(v, p, s));
 659                         s++;
 660                         limit <<= 3;
 661                 }
 662         }
 663
 664         /* Base-256 can handle any number, positive or negative. */
 665         return (format_256(v, p, maxsize));
 666 }
 667
 668 /*
 669  * Format a number into the specified field using base-256.
 670  */
 671 static int
 672 format_256(int64_t v, char *p, int s)
 673 {
 674         p += s;
 675         while (s-- > 0) {
 676                 *--p = (char)(v & 0xff);
 677                 v >>= 8;
 678         }
 679         *p |= 0x80; /* Set the base-256 marker bit. */
 680         return (0);
 681 }
 682
 683 /*
 684  * Format a number into the specified field.
 685  */
 686 static int
 687 format_octal(int64_t v, char *p, int s)
 688 {
 689         int len;
 690
 691         len = s;
 692
 693         /* Octal values can't be negative, so use 0. */
 694         if (v < 0) {
 695                 while (len-- > 0)
 696                         *p++ = '0';
 697                 return (-1);
 698         }
 699
 700         p += s;         /* Start at the end and work backwards. */
 701         while (s-- > 0) {
 702                 *--p = (char)('0' + (v & 7));
 703                 v >>= 3;
 704         }
 705
 706         if (v == 0)
 707                 return (0);
 708
 709         /* If it overflowed, fill field with max value. */
 710         while (len-- > 0)
 711                 *p++ = '7';
 712
 713         return (-1);
 714 }
 715
 716 static int
 717 archive_write_ustar_close(struct archive_write *a)
 718 {
 719         return (__archive_write_nulls(a, 512*2));
 720 }
 721
 722 static int
 723 archive_write_ustar_free(struct archive_write *a)
 724 {
 725         struct ustar *ustar;
 726
 727         ustar = (struct ustar *)a->format_data;
 728         free(ustar);
 729         a->format_data = NULL;
 730         return (ARCHIVE_OK);
 731 }
 732
 733 static int
 734 archive_write_ustar_finish_entry(struct archive_write *a)
 735 {
 736         struct ustar *ustar;
 737         int ret;
 738
 739         ustar = (struct ustar *)a->format_data;
 740         ret = __archive_write_nulls(a,
 741             (size_t)(ustar->entry_bytes_remaining + ustar->entry_padding));
 742         ustar->entry_bytes_remaining = ustar->entry_padding = 0;
 743         return (ret);
 744 }
 745
 746 static ssize_t
 747 archive_write_ustar_data(struct archive_write *a, const void *buff, size_t s)
 748 {
 749         struct ustar *ustar;
 750         int ret;
 751
 752         ustar = (struct ustar *)a->format_data;
 753         if (s > ustar->entry_bytes_remaining)
 754                 s = (size_t)ustar->entry_bytes_remaining;
 755         ret = __archive_write_output(a, buff, s);
 756         ustar->entry_bytes_remaining -= s;
 757         if (ret != ARCHIVE_OK)
 758                 return (ret);
 759         return (s);
 760 }