-
Notifications
You must be signed in to change notification settings - Fork 5.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
8277087: ZipException: zip END header not found at ZipFile#Source.findEND #6380
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
111 changes: 111 additions & 0 deletions
111
test/jdk/java/util/zip/ZipOutputStream/EmptyComment.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
/* | ||
* Copyright Amazon.com Inc. or its affiliates. All Rights Reserved. | ||
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | ||
* | ||
* This code is free software; you can redistribute it and/or modify it | ||
* under the terms of the GNU General Public License version 2 only, as | ||
* published by the Free Software Foundation. | ||
* | ||
* This code is distributed in the hope that it will be useful, but WITHOUT | ||
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | ||
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | ||
* version 2 for more details (a copy is included in the LICENSE file that | ||
* accompanied this code). | ||
* | ||
* You should have received a copy of the GNU General Public License version | ||
* 2 along with this work; if not, write to the Free Software Foundation, | ||
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | ||
* | ||
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA | ||
* or visit www.oracle.com if you need additional information or have any | ||
* questions. | ||
*/ | ||
|
||
import java.io.ByteArrayOutputStream; | ||
import java.util.function.Consumer; | ||
import java.util.zip.ZipEntry; | ||
import java.util.zip.ZipFile; | ||
import java.util.zip.ZipOutputStream; | ||
|
||
import org.testng.annotations.DataProvider; | ||
import org.testng.annotations.Test; | ||
|
||
import static org.testng.Assert.assertThrows; | ||
|
||
/** | ||
* @test | ||
* @bug 8277087 | ||
* @summary Verifies various use cases when the zip comment should be empty | ||
* @run testng EmptyComment | ||
*/ | ||
public final class EmptyComment { | ||
mrserb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
@DataProvider() | ||
Object[][] longLengths() { | ||
return new Object[][]{{0xFFFF + 1}, {0xFFFF + 2}, {0xFFFF * 2}}; | ||
} | ||
|
||
/** | ||
* Overflow, the text is too long to be stored as a comment. | ||
*/ | ||
@Test(dataProvider = "longLengths") | ||
void testOverflow(int length) throws Exception { | ||
test(zos -> assertThrows(IllegalArgumentException.class, () -> { | ||
zos.setComment("X".repeat(length)); | ||
})); | ||
} | ||
|
||
/** | ||
* Simple cases where the comment is set to the empty text. | ||
*/ | ||
@Test | ||
void testSimpleCases() throws Exception { | ||
test(zos -> {/* do nothing */}); | ||
test(zos -> zos.setComment(null)); | ||
test(zos -> zos.setComment("")); | ||
test(zos -> { | ||
zos.setComment(""); | ||
zos.setComment(null); | ||
}); | ||
test(zos -> { | ||
zos.setComment(null); | ||
zos.setComment(""); | ||
}); | ||
test(zos -> { | ||
zos.setComment("Comment"); | ||
zos.setComment(null); | ||
}); | ||
test(zos -> { | ||
zos.setComment("Comment"); | ||
zos.setComment(""); | ||
}); | ||
} | ||
|
||
private static void test(Consumer<ZipOutputStream> test) throws Exception { | ||
try (ByteArrayOutputStream baos = new ByteArrayOutputStream(); | ||
ZipOutputStream zos = new ZipOutputStream(baos)) { | ||
|
||
test.accept(zos); | ||
|
||
zos.putNextEntry(new ZipEntry("x")); | ||
zos.finish(); | ||
|
||
byte[] data = baos.toByteArray(); | ||
|
||
if (data.length > 0xFFFF) { // just in case | ||
throw new RuntimeException("data is too big: " + data.length); | ||
} | ||
int pk = data.length - ZipFile.ENDHDR; | ||
if (data[pk] != 'P' || data[pk + 1] != 'K') { | ||
throw new RuntimeException("PK is not found"); | ||
} | ||
// Since the comment is empty this will be two last bytes | ||
int pos = data.length - ZipFile.ENDHDR + ZipFile.ENDCOM; | ||
mrserb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
int len = (data[pos] & 0xFF) + ((data[pos + 1] & 0xFF) << 8); | ||
if (len != 0) { | ||
throw new RuntimeException("zip comment is not empty: " + len); | ||
} | ||
} | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The implementation change looks okay. I assume this regression slipped through due to lack of tests.
The method description doesn't make it clear that the comment can be null (ZipEntry.setComment has the same issue) so we should fix this while we are in the area, as a separate JBS of course as it will need a CSR to track the spec clarification.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ZipEntry::setComment indicates that the comment will be truncated if needed and ZipOutputStream takes care of this.
Perhaps writeEND() should also be updated to something like:
writeBytes(comment, 0, Math.min(comment.length, 0xffff))
Which is similar to what happens in writeCEN
Yes it would be nice to clarify that a null is accepted by setComment. When null is specified, the comment length is written as 0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mrserb Are you taking the spec clarification or should we just created another issue in JBS to track it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to update the spec for the null value for this method, and probably others in a separate CR, since this fix could be backported to the early releases. Will create such CR after agreement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have filed a separate issue: https://bugs.openjdk.java.net/browse/JDK-8277495