|
| 1 | +/* |
| 2 | + * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * This code is free software; you can redistribute it and/or modify it |
| 6 | + * under the terms of the GNU General Public License version 2 only, as |
| 7 | + * published by the Free Software Foundation. |
| 8 | + * |
| 9 | + * This code is distributed in the hope that it will be useful, but WITHOUT |
| 10 | + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 11 | + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 12 | + * version 2 for more details (a copy is included in the LICENSE file that |
| 13 | + * accompanied this code). |
| 14 | + * |
| 15 | + * You should have received a copy of the GNU General Public License version |
| 16 | + * 2 along with this work; if not, write to the Free Software Foundation, |
| 17 | + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 18 | + * |
| 19 | + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| 20 | + * or visit www.oracle.com if you need additional information or have any |
| 21 | + * questions. |
| 22 | + */ |
| 23 | + |
| 24 | +/* @test |
| 25 | + * @bug 8340553 |
| 26 | + * @summary Verify that ZipEntry(String), ZipEntry::setComment, and |
| 27 | + * ZipEntry::setExtra throws a IllegalArgumentException when the |
| 28 | + * combined length of the fields, including the size of the CEN Header, |
| 29 | + * exceeds 65,535 bytes |
| 30 | + * @run junit MaxZipEntryFieldSizeTest |
| 31 | + */ |
| 32 | + |
| 33 | +import org.junit.jupiter.api.BeforeEach; |
| 34 | +import org.junit.jupiter.api.Test; |
| 35 | +import org.junit.jupiter.params.ParameterizedTest; |
| 36 | +import org.junit.jupiter.params.provider.ValueSource; |
| 37 | + |
| 38 | +import java.io.IOException; |
| 39 | +import java.nio.ByteBuffer; |
| 40 | +import java.nio.ByteOrder; |
| 41 | +import java.nio.file.Files; |
| 42 | +import java.nio.file.Path; |
| 43 | +import java.util.zip.ZipEntry; |
| 44 | +import java.util.zip.ZipFile; |
| 45 | + |
| 46 | +import static org.junit.jupiter.api.Assertions.assertThrows; |
| 47 | + |
| 48 | +public class MaxZipEntryFieldSizeTest { |
| 49 | + |
| 50 | + // CEN header size + name length + comment length + extra length |
| 51 | + // should not exceed 65,535 bytes per the PKWare APP.NOTE |
| 52 | + // 4.4.10, 4.4.11, & 4.4.12. |
| 53 | + static final int MAX_COMBINED_CEN_HEADER_SIZE = 0xFFFF; |
| 54 | + // Maximum possible size of name length + comment length + extra length |
| 55 | + // for entries in order to not exceed 65,489 bytes |
| 56 | + static final int MAX_NAME_COMMENT_EXTRA_SIZE = |
| 57 | + MAX_COMBINED_CEN_HEADER_SIZE - ZipFile.CENHDR; |
| 58 | + // Tag for the 'unknown' field type, specified in APPNOTE.txt 'Third party mappings' |
| 59 | + static final short UNKNOWN_ZIP_TAG = (short) 0x9902; |
| 60 | + // Zip Entry name used by tests |
| 61 | + static final String ENTRY_NAME = "EntryName"; |
| 62 | + // Max length minus the size of the ENTRY_NAME or ENTRY_COMMENT |
| 63 | + static final int MAX_FIELD_LEN_MINUS_ENTRY_NAME = |
| 64 | + MAX_NAME_COMMENT_EXTRA_SIZE - 9; |
| 65 | + |
| 66 | + /** |
| 67 | + * Validate an IllegalArgumentException is thrown when the |
| 68 | + * combined length of the entry name, entry comment, entry extra data, |
| 69 | + * and CEN Header size exceeds 65,535 bytes. |
| 70 | + */ |
| 71 | + @ParameterizedTest |
| 72 | + @ValueSource(ints = {30000, 35000}) |
| 73 | + void combinedLengthTest(int length) { |
| 74 | + String comment = "a".repeat(length); |
| 75 | + byte[] bytes = creatExtraData(length); |
| 76 | + int combinedLength = ENTRY_NAME.length() + comment.length() + bytes.length; |
| 77 | + boolean expectException = combinedLength > MAX_COMBINED_CEN_HEADER_SIZE; |
| 78 | + System.out.printf("Combined Len= %s, exception: %s%n", combinedLength, expectException); |
| 79 | + ZipEntry zipEntry = new ZipEntry(ENTRY_NAME); |
| 80 | + zipEntry.setComment(comment); |
| 81 | + // The extra data length will trigger the IllegalArgumentException |
| 82 | + if (expectException) { |
| 83 | + assertThrows(IllegalArgumentException.class, () -> |
| 84 | + zipEntry.setExtra(bytes)); |
| 85 | + } else { |
| 86 | + zipEntry.setExtra(bytes); |
| 87 | + } |
| 88 | + } |
| 89 | + |
| 90 | + /** |
| 91 | + * Validate an IllegalArgumentException is thrown when the comment |
| 92 | + * length exceeds 65,489 bytes. |
| 93 | + */ |
| 94 | + @ParameterizedTest |
| 95 | + @ValueSource(ints = {MAX_COMBINED_CEN_HEADER_SIZE, |
| 96 | + MAX_NAME_COMMENT_EXTRA_SIZE, |
| 97 | + MAX_NAME_COMMENT_EXTRA_SIZE + 1, |
| 98 | + MAX_FIELD_LEN_MINUS_ENTRY_NAME, |
| 99 | + MAX_FIELD_LEN_MINUS_ENTRY_NAME - 1}) |
| 100 | + void setCommentLengthTest(int length) { |
| 101 | + boolean expectException = length >= MAX_NAME_COMMENT_EXTRA_SIZE; |
| 102 | + ZipEntry zipEntry = new ZipEntry(ENTRY_NAME); |
| 103 | + String comment = "a".repeat(length); |
| 104 | + System.out.printf("Comment Len= %s, exception: %s%n", comment.length(), expectException); |
| 105 | + // The comment length will trigger the IllegalArgumentException |
| 106 | + if (expectException) { |
| 107 | + assertThrows(IllegalArgumentException.class, () -> |
| 108 | + zipEntry.setComment(comment)); |
| 109 | + } else { |
| 110 | + zipEntry.setComment(comment); |
| 111 | + } |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * Validate an IllegalArgumentException is thrown when the name |
| 116 | + * length exceeds 65,489 bytes. |
| 117 | + */ |
| 118 | + @ParameterizedTest |
| 119 | + @ValueSource(ints = {MAX_COMBINED_CEN_HEADER_SIZE, |
| 120 | + MAX_NAME_COMMENT_EXTRA_SIZE, |
| 121 | + MAX_NAME_COMMENT_EXTRA_SIZE + 1, |
| 122 | + MAX_FIELD_LEN_MINUS_ENTRY_NAME, |
| 123 | + MAX_FIELD_LEN_MINUS_ENTRY_NAME - 1}) |
| 124 | + void nameLengthTest(int length) { |
| 125 | + boolean expectException = length > MAX_NAME_COMMENT_EXTRA_SIZE; |
| 126 | + String name = "a".repeat(length); |
| 127 | + System.out.printf("name Len= %s, exception: %s%n", name.length(), expectException); |
| 128 | + // The name length will trigger the IllegalArgumentException |
| 129 | + if (expectException) { |
| 130 | + assertThrows(IllegalArgumentException.class, () -> new ZipEntry(name)); |
| 131 | + } else { |
| 132 | + new ZipEntry(name); |
| 133 | + } |
| 134 | + } |
| 135 | + |
| 136 | + /** |
| 137 | + * Validate an IllegalArgumentException is thrown when the extra data |
| 138 | + * length exceeds 65,489 bytes. |
| 139 | + */ |
| 140 | + @ParameterizedTest |
| 141 | + @ValueSource(ints = {MAX_COMBINED_CEN_HEADER_SIZE, |
| 142 | + MAX_NAME_COMMENT_EXTRA_SIZE, |
| 143 | + MAX_NAME_COMMENT_EXTRA_SIZE + 1, |
| 144 | + MAX_FIELD_LEN_MINUS_ENTRY_NAME, |
| 145 | + MAX_FIELD_LEN_MINUS_ENTRY_NAME - 1}) |
| 146 | + void setExtraLengthTest(int length) { |
| 147 | + boolean expectException = length >= MAX_NAME_COMMENT_EXTRA_SIZE; |
| 148 | + byte[] bytes = creatExtraData(length); |
| 149 | + ZipEntry zipEntry = new ZipEntry(ENTRY_NAME); |
| 150 | + System.out.printf("extra Len= %s, exception: %s%n", bytes.length, expectException); |
| 151 | + // The extra data length will trigger the IllegalArgumentException |
| 152 | + if (expectException) { |
| 153 | + assertThrows(IllegalArgumentException.class, () -> zipEntry.setExtra(bytes)); |
| 154 | + } else { |
| 155 | + zipEntry.setExtra(bytes); |
| 156 | + } |
| 157 | + } |
| 158 | + |
| 159 | + /** |
| 160 | + * Create the extra field data which will be passed to ZipEntry::setExtra |
| 161 | + * @param length size of the extra data |
| 162 | + * @return byte array containing the extra data |
| 163 | + */ |
| 164 | + private static byte[] creatExtraData(int length) { |
| 165 | + byte[] bytes = new byte[length]; |
| 166 | + // Little-endian ByteBuffer for updating the header fields |
| 167 | + ByteBuffer buffer = ByteBuffer.wrap(bytes).order(ByteOrder.LITTLE_ENDIAN); |
| 168 | + // We use the 'unknown' tag, specified in APPNOTE.TXT, 4.6.1 Third party mappings' |
| 169 | + buffer.putShort(UNKNOWN_ZIP_TAG); |
| 170 | + // Size of the actual (empty) data |
| 171 | + buffer.putShort((short) (length - 2 * Short.BYTES)); |
| 172 | + return bytes; |
| 173 | + } |
| 174 | +} |
0 commit comments