Improve the resiliency of the packet deserialization code.
Packet deserializers now check for malformed input while reading the byte
stream. Deserializers are re-implemented as functions that take a byte array
and return a packet object. The old IPacket.deserialize(...) methods have been
deprecated with the goal of eventually moving to immutable packet objects.
Unit tests have been implemented for all Deserializer functions.
ONOS-1589
Change-Id: I9073d5e6e7991e15d43830cfd810989256b71c56
diff --git a/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborAdvertisementTest.java b/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborAdvertisementTest.java
index 0c95c6f..303db07 100644
--- a/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborAdvertisementTest.java
+++ b/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborAdvertisementTest.java
@@ -17,6 +17,8 @@
import org.junit.BeforeClass;
import org.junit.Test;
+import org.onlab.packet.DeserializationException;
+import org.onlab.packet.Deserializer;
import org.onlab.packet.MacAddress;
import static org.hamcrest.Matchers.is;
@@ -40,6 +42,9 @@
private static byte[] bytePacket;
+ private Deserializer<NeighborAdvertisement> deserializer
+ = NeighborAdvertisement.deserializer();
+
@BeforeClass
public static void setUpBeforeClass() throws Exception {
byte[] byteHeader = {
@@ -75,9 +80,8 @@
* Tests deserialize and getters.
*/
@Test
- public void testDeserialize() {
- NeighborAdvertisement na = new NeighborAdvertisement();
- na.deserialize(bytePacket, 0, bytePacket.length);
+ public void testDeserialize() throws DeserializationException {
+ NeighborAdvertisement na = deserializer.deserialize(bytePacket, 0, bytePacket.length);
assertThat(na.getRouterFlag(), is((byte) 1));
assertThat(na.getSolicitedFlag(), is((byte) 1));
diff --git a/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborSolicitationTest.java b/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborSolicitationTest.java
index 09e0117..2571b7a 100644
--- a/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborSolicitationTest.java
+++ b/utils/misc/src/test/java/org/onlab/packet/ndp/NeighborSolicitationTest.java
@@ -17,6 +17,8 @@
import org.junit.BeforeClass;
import org.junit.Test;
+import org.onlab.packet.DeserializationException;
+import org.onlab.packet.Deserializer;
import org.onlab.packet.MacAddress;
import static org.hamcrest.Matchers.is;
@@ -46,6 +48,9 @@
private static byte[] bytePacket;
+ private Deserializer<NeighborSolicitation> deserializer
+ = NeighborSolicitation.deserializer();
+
@BeforeClass
public static void setUpBeforeClass() throws Exception {
byte[] byteHeader = {
@@ -78,9 +83,8 @@
* Tests deserialize and getters.
*/
@Test
- public void testDeserialize() {
- NeighborSolicitation ns = new NeighborSolicitation();
- ns.deserialize(bytePacket, 0, bytePacket.length);
+ public void testDeserialize() throws DeserializationException {
+ NeighborSolicitation ns = deserializer.deserialize(bytePacket, 0, bytePacket.length);
assertArrayEquals(ns.getTargetAddress(), TARGET_ADDRESS);
diff --git a/utils/misc/src/test/java/org/onlab/packet/ndp/RedirectTest.java b/utils/misc/src/test/java/org/onlab/packet/ndp/RedirectTest.java
index 865f03a..7d0d56c 100644
--- a/utils/misc/src/test/java/org/onlab/packet/ndp/RedirectTest.java
+++ b/utils/misc/src/test/java/org/onlab/packet/ndp/RedirectTest.java
@@ -17,6 +17,8 @@
import org.junit.BeforeClass;
import org.junit.Test;
+import org.onlab.packet.DeserializationException;
+import org.onlab.packet.Deserializer;
import org.onlab.packet.MacAddress;
import static org.hamcrest.Matchers.is;
@@ -52,6 +54,8 @@
private static byte[] bytePacket;
+ private Deserializer<Redirect> deserializer = Redirect.deserializer();
+
@BeforeClass
public static void setUpBeforeClass() throws Exception {
byte[] byteHeader = {
@@ -89,9 +93,8 @@
* Tests deserialize and getters.
*/
@Test
- public void testDeserialize() {
- Redirect rd = new Redirect();
- rd.deserialize(bytePacket, 0, bytePacket.length);
+ public void testDeserialize() throws DeserializationException {
+ Redirect rd = deserializer.deserialize(bytePacket, 0, bytePacket.length);
assertArrayEquals(rd.getTargetAddress(), TARGET_ADDRESS);
assertArrayEquals(rd.getDestinationAddress(), DESTINATION_ADDRESS);
diff --git a/utils/misc/src/test/java/org/onlab/packet/ndp/RouterAdvertisementTest.java b/utils/misc/src/test/java/org/onlab/packet/ndp/RouterAdvertisementTest.java
index b69d142..d65dd51 100644
--- a/utils/misc/src/test/java/org/onlab/packet/ndp/RouterAdvertisementTest.java
+++ b/utils/misc/src/test/java/org/onlab/packet/ndp/RouterAdvertisementTest.java
@@ -17,6 +17,8 @@
import org.junit.BeforeClass;
import org.junit.Test;
+import org.onlab.packet.DeserializationException;
+import org.onlab.packet.Deserializer;
import org.onlab.packet.MacAddress;
import static org.hamcrest.Matchers.is;
@@ -34,6 +36,9 @@
private static byte[] bytePacket;
+ private Deserializer<RouterAdvertisement> deserializer
+ = RouterAdvertisement.deserializer();
+
@BeforeClass
public static void setUpBeforeClass() throws Exception {
byte[] byteHeader = {
@@ -69,9 +74,8 @@
* Tests deserialize and getters.
*/
@Test
- public void testDeserialize() {
- RouterAdvertisement ra = new RouterAdvertisement();
- ra.deserialize(bytePacket, 0, bytePacket.length);
+ public void testDeserialize() throws DeserializationException {
+ RouterAdvertisement ra = deserializer.deserialize(bytePacket, 0, bytePacket.length);
assertThat(ra.getCurrentHopLimit(), is((byte) 3));
assertThat(ra.getMFlag(), is((byte) 1));
diff --git a/utils/misc/src/test/java/org/onlab/packet/ndp/RouterSolicitationTest.java b/utils/misc/src/test/java/org/onlab/packet/ndp/RouterSolicitationTest.java
index 9c087e3..173baaa 100644
--- a/utils/misc/src/test/java/org/onlab/packet/ndp/RouterSolicitationTest.java
+++ b/utils/misc/src/test/java/org/onlab/packet/ndp/RouterSolicitationTest.java
@@ -17,7 +17,9 @@
import org.junit.BeforeClass;
import org.junit.Test;
+import org.onlab.packet.Deserializer;
import org.onlab.packet.MacAddress;
+import org.onlab.packet.PacketTestUtils;
import static org.hamcrest.Matchers.is;
import static org.junit.Assert.assertArrayEquals;
@@ -36,6 +38,9 @@
private static byte[] bytePacket;
+ private Deserializer<RouterSolicitation> deserializer
+ = RouterSolicitation.deserializer();
+
@BeforeClass
public static void setUpBeforeClass() throws Exception {
byte[] byteHeader = {
@@ -59,13 +64,22 @@
assertArrayEquals(rs.serialize(), bytePacket);
}
+ @Test
+ public void testDeserializeBadInput() throws Exception {
+ PacketTestUtils.testDeserializeBadInput(RouterSolicitation.deserializer());
+ }
+
+ @Test
+ public void testDeserializeTruncated() throws Exception {
+ PacketTestUtils.testDeserializeTruncated(RouterSolicitation.deserializer(), bytePacket);
+ }
+
/**
* Tests deserialize and getters.
*/
@Test
- public void testDeserialize() {
- RouterSolicitation rs = new RouterSolicitation();
- rs.deserialize(bytePacket, 0, bytePacket.length);
+ public void testDeserialize() throws Exception {
+ RouterSolicitation rs = deserializer.deserialize(bytePacket, 0, bytePacket.length);
// Check the option(s)
assertThat(rs.getOptions().size(), is(1));