Skip to content

IO-429: Check for long streams in IOUtils.toByteArray #175

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.

Sign up for GitHub

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

Closed
leskin-in wants to merge 2 commits into from
Closed

IO-429: Check for long streams in IOUtils.toByteArray #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
86da8e4
IO-429: Check for long streams in IOUtils.toByteArray
Dec 15, 2020
12a78ee
IO-429: Test case for IOUtils.toByteArray() with long InputStream
May 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/main/java/org/apache/commons/io/IOUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2394,10 +2394,13 @@ public static BufferedReader toBufferedReader(final Reader reader, final int siz
* @return the requested byte array.
* @throws NullPointerException if the InputStream is {@code null}.
* @throws IOException if an I/O error occurs.
* @throws IllegalArgumentException if input is longer than the maximum Java array length.
*/
public static byte[] toByteArray(final InputStream inputStream) throws IOException {
try (final ByteArrayOutputStream output = new ByteArrayOutputStream()) {
copy(inputStream, output);
if (copy(inputStream, output) == -1) {
throw new IllegalArgumentException("Stream cannot be longer than Integer max value bytes");
Copy link
Member

@garydgregory garydgregory Dec 29, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leskin-in
This condition will not happen for a ByteArrayInputStream, instead of you'll get a IndexOutOfBoundsException or am I missing something?

Copy link
Author

@leskin-in leskin-in May 13, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is correct if an InputStream is a ByteArrayInputStream. However, this method accepts generic InputStream, which may wrap more data. In that case, the implementation of copy() would return -1.

However, ByteArrayOutputStream, which is created in this method as an intermediate buffer, does not check for its underlying buffer overflow at write(). The checks in write() only ensure sanity of arguments passed to it; they are valid in case of copyLarge() (ultimately called by copy() mentioned above).

The ByteArrayOutputStream, however, can store more than Integer.MAX_VALUE bytes because it can use multiple underlying byte arrays.

}
return output.toByteArray();
}
}
Expand Down
7 changes: 6 additions & 1 deletion src/test/java/org/apache/commons/io/IOUtilsTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import java.util.List;

import org.apache.commons.io.function.IOConsumer;
import org.apache.commons.io.input.CircularInputStream;
import org.apache.commons.io.input.NullInputStream;
import org.apache.commons.io.output.AppendableWriter;
import org.apache.commons.io.output.NullOutputStream;
Expand Down Expand Up @@ -1435,9 +1436,13 @@ public void testToByteArray_InputStream() throws Exception {
}
}

@Test public void testToByteArray_InputStreamTooLong() throws Exception {
CircularInputStream cin = new CircularInputStream(new byte[]{65, 65, 65}, ((long)Integer.MAX_VALUE) + 1L);
assertThrows(IllegalArgumentException.class, () -> IOUtils.toByteArray(cin));
}

@Test
public void testToByteArray_InputStream_NegativeSize() throws Exception {

try (FileInputStream fin = new FileInputStream(testFile)) {
IOUtils.toByteArray(fin, -1);
fail("IllegalArgumentException expected");
Expand Down