Skip to content

[COMPRESS-732] Add a configurable maxEntries option to all archivers - #840

Open
samiusss wants to merge 1 commit into
apache:masterfrom
samiusss:max-entries
Open

samiusss wants to merge 1 commit into
apache:masterfrom
samiusss:max-entries

Conversation

@samiusss

Copy link
Copy Markdown

Adds AbstractArchiveBuilder.setMaxEntries(int), next to setMaxEntryNameLength(int), so callers can cap how many entries a reader accepts.

Why in the library: ZipFile and TarFile load every entry when they are opened, and SevenZFile sizes its entry table from the header. A caller cannot count entries before that memory is spent, so wrapping the input in a BoundedInputStream does not help here. Streaming readers enforce the same limit in getNextEntry(), so the option behaves the same across all formats.

How:

  • ZipFile and TarFile check while collecting entries; SevenZFile checks the declared file count before building its table.
  • Streaming readers (ar, arj, cpio, dump, lha, tar, zip, jar) pass the entry they return through a new protected ArchiveInputStream.countEntry(E).
  • Both paths share ArchiveUtils.checkEntryCount(long, int) and throw an ArchiveException.
  • The default is Integer.MAX_VALUE, so existing behavior is unchanged. Non-positive values are rejected, like setMaxEntryNameLength.

MaxEntriesTest covers every reader: a limit equal to the entry count reads the whole archive, one less fails on the last entry.

Related to COMPRESS-726, which caps the decompressed size of compressor streams; this is the archive-level counterpart.

  • Read the contribution guidelines for this project.
  • Read the ASF Generative Tooling Guidance if you use Artificial Intelligence (AI).
  • I used AI to create any part of, or all of, this pull request. Which AI tool was used to create this pull request, and to what extent did it contribute? Claude (Anthropic) assisted with the implementation and tests. I reviewed the change and take responsibility for it.
  • Run a successful build using the default Maven goal with mvn; that's mvn on the command line by itself.
  • Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best practice.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.

AbstractArchiveBuilder.setMaxEntries(int) caps the number of entries a
reader accepts, next to setMaxEntryNameLength(int). ZipFile and TarFile
load every entry when opened and SevenZFile sizes its entry table from
the header, so a caller cannot apply this limit on their own before the
memory is spent. Streaming readers enforce the same limit in
getNextEntry(), keeping the option uniform across all formats.

The default is Integer.MAX_VALUE, so existing behavior is unchanged.
@samiusss samiusss changed the title Add a configurable maxEntries option to all archivers [COMPRESS-732] Add a configurable maxEntries option to all archivers Nov 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant