Add checks to setting output buffer and throw IllegalArgumentException when setting a buffer size greater than the max buffer size

Author: WilliamDo

src/com/esotericsoftware/kryo/io/Output.java

@@ -15,8 +15,8 @@
  * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
-
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
+
 package com.esotericsoftware.kryo.io;
 
 import com.esotericsoftware.kryo.KryoException;
@@ -54,6 +54,8 @@ public Output (int bufferSize) {
 	 * @param maxBufferSize The buffer is doubled as needed until it exceeds maxBufferSize and an exception is thrown. Can be -1
 	 *           for no maximum. */
 	public Output (int bufferSize, int maxBufferSize) {
+		if (bufferSize > maxBufferSize && maxBufferSize != -1)
+			throw new IllegalArgumentException("bufferSize: " + bufferSize + " cannot be greater than maxBufferSize: " + maxBufferSize);
 		if (maxBufferSize < -1) throw new IllegalArgumentException("maxBufferSize cannot be < -1: " + maxBufferSize);
 		this.capacity = bufferSize;
 		this.maxCapacity = maxBufferSize == -1 ? Integer.MAX_VALUE : maxBufferSize;
@@ -110,6 +112,8 @@ public void setBuffer (byte[] buffer) {
 	 * @param maxBufferSize The buffer is doubled as needed until it exceeds maxBufferSize and an exception is thrown. */
 	public void setBuffer (byte[] buffer, int maxBufferSize) {
 		if (buffer == null) throw new IllegalArgumentException("buffer cannot be null.");
+		if (buffer.length > maxBufferSize && maxBufferSize != -1)
+			throw new IllegalArgumentException("buffer has length: " + buffer.length + " cannot be greater than maxBufferSize: " + maxBufferSize);
 		if (maxBufferSize < -1) throw new IllegalArgumentException("maxBufferSize cannot be < -1: " + maxBufferSize);
 		this.buffer = buffer;
 		this.maxCapacity = maxBufferSize == -1 ? Integer.MAX_VALUE : maxBufferSize;
@@ -729,4 +733,4 @@ public void writeDoubles (double[] object) throws KryoException {
 		for (int i = 0, n = object.length; i < n; i++)
 			writeDouble(object[i]);
 	}
-}
+}

test/com/esotericsoftware/kryo/InputOutputTest.java

@@ -15,8 +15,8 @@
  * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
- * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
-
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
+
 package com.esotericsoftware.kryo;
 
 import java.io.ByteArrayInputStream;
@@ -869,4 +869,52 @@ public void testFlushRoundTrip() throws Exception {
 		assertEquals(s1, s2);
 
 	}
-}
+
+	public void testNewOutputMaxBufferSizeLessThanBufferSize() {
+		int bufferSize = 2;
+		int maxBufferSize = 1;
+
+		try {
+			new Output(bufferSize, maxBufferSize);
+			fail("Expecting IllegalArgumentException not thrown");
+		} catch (IllegalArgumentException e) {
+			// This exception is expected
+		}
+	}
+
+	public void testSetOutputMaxBufferSizeLessThanBufferSize() {
+		int bufferSize = 2;
+		int maxBufferSize = 1;
+
+		Output output = new Output(bufferSize, bufferSize);
+		assertNotNull(output);
+
+		try {
+			output.setBuffer(new byte[bufferSize], maxBufferSize);
+			fail("Expecting IllegalArgumentException not thrown");
+		} catch (IllegalArgumentException e) {
+			// This exception is expected
+		}
+
+	}
+
+	public void testNewOutputMaxBufferSizeIsMinusOne() {
+		int bufferSize = 2;
+		int maxBufferSize = -1;
+
+		Output output = new Output(bufferSize, maxBufferSize);
+		assertNotNull(output);
+		// This test should pass as long as no exception thrown
+	}
+
+	public void testSetOutputMaxBufferSizeIsMinusOne() {
+		int bufferSize = 2;
+		int maxBufferSize = -1;
+
+		Output output = new Output(bufferSize, bufferSize);
+		assertNotNull(output);
+		output.setBuffer(new byte[bufferSize], maxBufferSize);
+		// This test should pass as long as no exception thrown
+	}
+
+}