package edu.uci.iotproject.util;
-import edu.uci.iotproject.Conversation;
+import edu.uci.iotproject.trafficreassembly.layer3.Conversation;
import edu.uci.iotproject.analysis.PcapPacketPair;
import edu.uci.iotproject.analysis.TcpConversationUtils;
import edu.uci.iotproject.analysis.TriggerTrafficExtractor;
import org.apache.commons.math3.stat.clustering.Cluster;
import org.pcap4j.core.PcapPacket;
+import org.pcap4j.packet.EthernetPacket;
import org.pcap4j.packet.IpV4Packet;
import org.pcap4j.packet.TcpPacket;
+import org.pcap4j.util.MacAddress;
import java.util.*;
*/
private static final int SIGNATURE_MERGE_THRESHOLD = 5;
+
+ /**
+ * Gets the source address of the Ethernet part of {@code packet}.
+ * @param packet The packet for which the Ethernet source address is to be extracted.
+ * @return The source address of the Ethernet part of {@code packet}.
+ */
+ public static MacAddress getEthSrcAddr(PcapPacket packet) {
+ return getEthernetPacketOrThrow(packet).getHeader().getSrcAddr();
+ }
+
+ /**
+ * Gets the destination address of the Ethernet part of {@code packet}.
+ * @param packet The packet for which the Ethernet destination address is to be extracted.
+ * @return The destination address of the Ethernet part of {@code packet}.
+ */
+ public static MacAddress getEthDstAddr(PcapPacket packet) {
+ return getEthernetPacketOrThrow(packet).getHeader().getDstAddr();
+ }
+
/**
* Determines if a given {@link PcapPacket} wraps a {@link TcpPacket}.
* @param packet The {@link PcapPacket} to inspect.
* Gets the source IP (in decimal format) of an IPv4 packet.
* @param packet The packet for which the IPv4 source address is to be extracted.
* @return The decimal representation of the source IP of {@code packet} <em>iff</em> {@code packet} wraps an
- * {@link IpV4Packet}, otherwise {@code null}.
+ * {@link IpV4Packet}.
+ * @throws NullPointerException if {@code packet} does not encapsulate an {@link IpV4Packet}.
*/
public static String getSourceIp(PcapPacket packet) {
- IpV4Packet ipPacket = packet.get(IpV4Packet.class);
- return ipPacket == null ? null : ipPacket.getHeader().getSrcAddr().getHostAddress();
+ return getIpV4PacketOrThrow(packet).getHeader().getSrcAddr().getHostAddress();
+ }
+
+ /**
+ * Gets the destination IP (in decimal format) of an IPv4 packet.
+ * @param packet The packet for which the IPv4 source address is to be extracted.
+ * @return The decimal representation of the destination IP of {@code packet} <em>iff</em> {@code packet} wraps an
+ * {@link IpV4Packet}.
+ * @throws NullPointerException if {@code packet} does not encapsulate an {@link IpV4Packet}.
+ */
+ public static String getDestinationIp(PcapPacket packet) {
+ return getIpV4PacketOrThrow(packet).getHeader().getDstAddr().getHostAddress();
}
/**
return ipDst.equals(ip) && dstPort == port;
}
+ /**
+ * Checks if the source IP address of the {@link IpV4Packet} contained in {@code packet} is a local address, i.e.,
+ * if it pertains to subnet 10.0.0.0/8, 172.16.0.0/16, or 192.168.0.0/16.
+ * @param packet The packet for which the source IP address is to be examined.
+ * @return {@code true} if {@code packet} wraps a {@link IpV4Packet} for which the source IP address is a local IP
+ * address, {@code false} otherwise.
+ * @throws NullPointerException if {@code packet} does not encapsulate an {@link IpV4Packet}.
+ */
+ public static boolean isSrcIpLocal(PcapPacket packet) {
+ return getIpV4PacketOrThrow(packet).getHeader().getSrcAddr().isSiteLocalAddress();
+ }
+
+ /**
+ * Checks if the destination IP address of the {@link IpV4Packet} contained in {@code packet} is a local address,
+ * i.e., if it pertains to subnet 10.0.0.0/8, 172.16.0.0/16, or 192.168.0.0/16.
+ * @param packet The packet for which the destination IP address is to be examined.
+ * @return {@code true} if {@code packet} wraps a {@link IpV4Packet} for which the destination IP address is a local
+ * IP address, {@code false} otherwise.
+ * @throws NullPointerException if {@code packet} does not encapsulate an {@link IpV4Packet}.
+ */
+ public static boolean isDstIpLocal(PcapPacket packet) {
+ return getIpV4PacketOrThrow(packet).getHeader().getDstAddr().isSiteLocalAddress();
+ }
+
/**
* Checks if {@code packet} wraps a TCP packet that has the SYN flag set.
* @param packet A {@link PcapPacket} that is suspected to contain a {@link TcpPacket} for which the SYN flag is set.
*/
public static List<List<List<PcapPacket>>>
mergeSignatures(List<List<List<PcapPacket>>> signatures, List<Conversation> conversations) {
- // Make a copy first.
- List<List<List<PcapPacket>>> copySignatures = new ArrayList<>(signatures);
+
+ // TODO: THIS IS NOT A DEEP COPY; IT BASICALLY CREATES A REFERENCE TO THE SAME LIST OBJECT
+ // List<List<List<PcapPacket>>> copySignatures = new ArrayList<>(signatures);
+ // Make a deep copy first.
+ List<List<List<PcapPacket>>> copySignatures = new ArrayList<>();
+ listDeepCopy(copySignatures, signatures);
// Traverse and look into the pairs of signatures.
for (int first = 0; first < signatures.size(); first++) {
List<List<PcapPacket>> firstList = signatures.get(first);
if (secondList.size() < SIGNATURE_MERGE_THRESHOLD) {
// Prune the unsuccessfully merged signatures (i.e., these will have size() < maxSignatureEl).
final int maxNumOfEl = maxSignatureEl;
+ // TODO: DOUBLE CHECK IF WE REALLY NEED TO PRUNE FAILED BINDINGS
+ // TODO: SOMETIMES THE SEQUENCES ARE JUST INCOMPLETE
+ // TODO: AND BOTH THE COMPLETE AND INCOMPLETE SEQUENCES ARE VALID SIGNATURES!
firstList.removeIf(el -> el.size() < maxNumOfEl);
// Remove the merged set of signatures when successful.
signatures.remove(secondList);
return signatures;
}
+ /**
+ * Deep copy to create an entirely new {@link List} of {@link List} of {@link List} of {@link PcapPacket} objects.
+ * @param destList A {@link List} of {@link List} of {@link List} of
+ * {@link PcapPacket} objects that will be the final container of the deep copy
+ * @param sourceList A {@link List} of {@link List} of {@link List} of
+ * {@link PcapPacket} objects that will be the source of the deep copy.
+ */
+ private static void listDeepCopy(List<List<List<PcapPacket>>> destList, List<List<List<PcapPacket>>> sourceList) {
+
+ for(List<List<PcapPacket>> llPcapPacket : sourceList) {
+ List<List<PcapPacket>> tmpListOfList = new ArrayList<>();
+ for(List<PcapPacket> lPcapPacket : llPcapPacket) {
+ List<PcapPacket> tmpList = new ArrayList<>();
+ for(PcapPacket pcapPacket : lPcapPacket) {
+ tmpList.add(pcapPacket);
+ }
+ tmpListOfList.add(tmpList);
+ }
+ destList.add(tmpListOfList);
+ }
+ }
+
/**
* Sort the signatures in the {@code List} of {@code List} of {@code List} of {@code PcapPacket} objects.
* The purpose of this is to sort the order of signatures in the signature list. For detection purposes, we need
public static List<List<List<PcapPacket>>> sortSignatures(List<List<List<PcapPacket>>> signatures) {
// TODO: This is the simplest solution!!! Might not cover all corner cases.
// TODO: Sort the list of lists based on the first packet's timestamps!
- //Collections.sort(signatures, (p1, p2) -> {
- // return p1.get(0).get(0).getTimestamp().compareTo(p2.get(0).get(0).getTimestamp());
- //});
+// Collections.sort(signatures, (p1, p2) -> {
+// return p1.get(0).get(0).getTimestamp().compareTo(p2.get(0).get(0).getTimestamp());
+// });
// TODO: The following is a more complete solution that covers corner cases.
// Sort the list of lists based on one-to-one comparison between timestamps of signatures on both lists.
// This also takes into account the fact that the number of signatures in the two lists could be different.
int count1 = 0;
int count2 = 0;
// Need to make sure that both are not out of bound!
- while(count1 + 1 < p1.size() && count2 + 1 < p2.size()) {
+ while (count1 + 1 < p1.size() && count2 + 1 < p2.size()) {
long timestamp1 = p1.get(count1).get(0).getTimestamp().toEpochMilli();
long timestamp2 = p2.get(count2).get(0).getTimestamp().toEpochMilli();
// The two timestamps have to be within a 15-second window!
- if(Math.abs(timestamp1 - timestamp2) < TriggerTrafficExtractor.INCLUSION_WINDOW_MILLIS) {
+ if (Math.abs(timestamp1 - timestamp2) < TriggerTrafficExtractor.INCLUSION_WINDOW_MILLIS) {
// If these two are within INCLUSION_WINDOW_MILLIS window then compare!
compare = p1.get(count1).get(0).getTimestamp().compareTo(p2.get(count2).get(0).getTimestamp());
if (comparePrev != 0) { // First time since it is 0
if (Integer.signum(compare) != Integer.signum(comparePrev)) {
// Throw an exception if the order of the two signatures is not consistent,
// E.g., 111, 222, 333 in one occassion and 222, 333, 111 in the other.
- throw new Error("For some reason, the order of signatures are not always consistent!" +
- "Returning the original data structure of signatures...");
+// throw new Error("For some reason, the order of signatures are not always consistent!" +
+// "Returning the original data structure of signatures...");
}
}
comparePrev = compare;
} else {
// If not within INCLUSION_WINDOW_MILLIS window then find the correct pair
// by incrementing one of them.
- if(timestamp1 < timestamp2)
+ if (timestamp1 < timestamp2)
count1++;
else
count2++;
});
return signatures;
}
+
+ /**
+ * Gets the {@link IpV4Packet} contained in {@code packet}, or throws a {@link NullPointerException} if
+ * {@code packet} does not contain an {@link IpV4Packet}.
+ * @param packet A {@link PcapPacket} that is expected to contain an {@link IpV4Packet}.
+ * @return The {@link IpV4Packet} contained in {@code packet}.
+ * @throws NullPointerException if {@code packet} does not encapsulate an {@link IpV4Packet}.
+ */
+ private static IpV4Packet getIpV4PacketOrThrow(PcapPacket packet) {
+ return Objects.requireNonNull(packet.get(IpV4Packet.class), "not an IPv4 packet");
+ }
+
+ /**
+ * Gets the {@link EthernetPacket} contained in {@code packet}, or throws a {@link NullPointerException} if
+ * {@code packet} does not contain an {@link EthernetPacket}.
+ * @param packet A {@link PcapPacket} that is expected to contain an {@link EthernetPacket}.
+ * @return The {@link EthernetPacket} contained in {@code packet}.
+ * @throws NullPointerException if {@code packet} does not encapsulate an {@link EthernetPacket}.
+ */
+ private static final EthernetPacket getEthernetPacketOrThrow(PcapPacket packet) {
+ return Objects.requireNonNull(packet.get(EthernetPacket.class), "not an Ethernet packet");
+ }
+
+ /**
+ * Print signatures in {@code List} of {@code List} of {@code List} of {@code PcapPacket} objects.
+ *
+ * @param signatures A {@link List} of {@link List} of {@link List} of
+ * {@link PcapPacket} objects that needs to be printed.
+ */
+ public static void printSignatures(List<List<List<PcapPacket>>> signatures) {
+
+ // Iterate over the list of all clusters/sequences
+ int sequenceCounter = 0;
+ for(List<List<PcapPacket>> listListPcapPacket : signatures) {
+ // Iterate over every member of a cluster/sequence
+ System.out.print("====== SEQUENCE " + sequenceCounter++);
+ System.out.println(" - " + listListPcapPacket.size() + " MEMBERS ======");
+ for(List<PcapPacket> listPcapPacket : listListPcapPacket) {
+ // Print out packet lengths in a sequence
+ int packetCounter = 0;
+ for(PcapPacket pcapPacket : listPcapPacket) {
+ if(pcapPacket != null) {
+ System.out.print(pcapPacket.length());
+ }
+ if(packetCounter < listPcapPacket.size() - 1) {
+ System.out.print(" "); // Provide space if not last packet
+ } else {
+ System.out.println(); // Newline if last packet
+ }
+ packetCounter++;
+ }
+ }
+ }
+ }
+
+ /**
+ * Remove a sequence in a signature object.
+ *
+ * @param signatures A {@link List} of {@link List} of {@link List} of
+ * {@link PcapPacket} objects.
+ * @param sequenceIndex An index for a sequence that consists of {{@link List} of {@link List} of
+ * {@link PcapPacket} objects.
+ */
+ public static void removeSequenceFromSignature(List<List<List<PcapPacket>>> signatures, int sequenceIndex) {
+
+ // Sequence index starts from 0
+ signatures.remove(sequenceIndex);
+ }
}
projects / pingpong.git / blobdiff