remix-run/remix tar-parser@0.8.0

tar-parser v0.8.0

on GitHub

Minor Changes

• BREAKING CHANGE: parseTarHeader(), parseTar(), and TarParser now default to pathPolicy: 'relative', throwing TarParseError for empty entry names or link targets, absolute paths, Windows drive prefixes, backslashes, and embedded NULs. Entry names cannot contain .. path components. Symlink targets are checked relative to the link's parent directory, and hard-link targets relative to the archive root; .. components are allowed only when resolution stays within the archive. Valid paths retain their spelling, including nested paths, ./ prefixes, and trailing directory slashes. Applications that need to inspect or process unrestricted archive paths can opt into pathPolicy: 'preserve':

  -await parseTar(archive, handleEntry)
  +await parseTar(archive, { pathPolicy: 'preserve' }, handleEntry)

  The same option works with parseTarHeader() and new TarParser(). It does not disable archive limits or header structure validation. Path validation applies after ustar prefixes and GNU/PAX overrides, before an entry reaches the handler. GNU long names and link targets now omit their terminating NUL under either policy. Extractors must still enforce containment on their destination filesystem, including when existing or archived symlinks are present.

• BREAKING CHANGE: parseTar() and TarParser now default to limits of 2 MiB per entry body, 20 MiB of total archive input, and 5,000 entries, where previously none were limited. Applications processing larger archives must configure maxEntrySize, maxTotalSize, and maxEntries to raise the applicable limits, or set any limit to Infinity to disable it:

  -await parseTar(archive, handleEntry)
  +await parseTar(
  +  archive,
  +  { maxEntrySize: Infinity, maxTotalSize: Infinity, maxEntries: Infinity },
  +  handleEntry,
  +)

  The entry size and count limits include PAX/GNU metadata entries and are checked before reading their bodies or invoking entry handlers. Padding and end markers do not count as entries. The total size limit counts all input bytes, including headers, padding, and metadata, after any upstream decompression. Exceeding a limit throws the exported MaxEntrySizeExceededError, MaxTotalSizeExceededError, or MaxEntriesExceededError, all extending TarParseError.

  Global PAX metadata now applies to subsequent entries even without a local PAX header, so global sizes are parsed and checked against the entry limit. Local PAX values continue to take precedence.

Patch Changes

• Buffer TarEntry content using the bytes received, validate octal, base-256, and PAX entry sizes, and reject unfinished body readers when archive parsing fails.

• Reduce allocation and copying when GNU or PAX metadata arrives in small chunks. Metadata buffering grows with the bytes received and continues to honor the configured archive limits.