Code/Projects/SmartPlugDetector/src/main/java/edu/uci/iotproject/detection/SignatureDetector.java

   1 package edu.uci.iotproject.detection;
   2
   3 import edu.uci.iotproject.analysis.TriggerTrafficExtractor;
   4 import edu.uci.iotproject.analysis.UserAction;
   5 import edu.uci.iotproject.io.PcapHandleReader;
   6 import edu.uci.iotproject.util.PrintUtils;
   7 import org.jgrapht.GraphPath;
   8 import org.jgrapht.alg.shortestpath.DijkstraShortestPath;
   9 import org.jgrapht.graph.DefaultWeightedEdge;
  10 import org.jgrapht.graph.SimpleDirectedWeightedGraph;
  11 import org.pcap4j.core.*;
  12
  13 import java.time.Duration;
  14 import java.time.Instant;
  15 import java.time.ZoneId;
  16 import java.time.format.DateTimeFormatter;
  17 import java.time.format.FormatStyle;
  18 import java.util.*;
  19 import java.util.function.Consumer;
  20
  21 /**
  22  * Detects an event signature that spans one or multiple TCP connections.
  23  *
  24  * @author Janus Varmarken {@literal <jvarmark@uci.edu>}
  25  * @author Rahmadi Trimananda {@literal <rtrimana@uci.edu>}
  26  */
  27 public class SignatureDetector implements PacketListener, ClusterMatcher.ClusterMatchObserver {
  28
  29     // Test client
  30     public static void main(String[] args) throws PcapNativeException, NotOpenException {
  31         String path = "/scratch/July-2018"; // Rahmadi
  32         //String path = "/Users/varmarken/temp/UCI IoT Project/experiments"; // Janus
  33
  34         // No activity test
  35         //final String inputPcapFile = path + "/evaluation/no-activity/no-activity.wlan1.pcap";
  36
  37         // D-Link Siren experiment
  38 //        final String inputPcapFile = path + "/evaluation/dlink-siren/dlink-siren.data.wlan1.pcap";
  39 //        final String inputPcapFile = path + "/evaluation/dlink-siren/dlink-siren.eth0.local.pcap";
  40         // D-Link Siren DEVICE signatures
  41 //        final String onSignatureFile = path + "/2018-08/dlink-siren/onSignature-DLink-Siren-device.sig";
  42 //        final String offSignatureFile = path + "/2018-08/dlink-siren/offSignature-DLink-Siren-device.sig";
  43         // D-Link Siren PHONE signatures
  44 //        final String onSignatureFile = path + "/2018-08/dlink-siren/onSignature-DLink-Siren-phone.sig";
  45 //        final String offSignatureFile = path + "/2018-08/dlink-siren/offSignature-DLink-Siren-phone.sig";
  46
  47         /*
  48         // Kwikset Doorlock Sep 12 experiment
  49 //        final String inputPcapFile = path + "/evaluation/kwikset-doorlock/kwikset-doorlock.data.wlan1.pcap";
  50         final String inputPcapFile = path + "/evaluation/kwikset-doorlock/kwikset-doorlock.data.eth0.pcap";
  51 //        // Kwikset Doorlock PHONE signatures
  52         final String onSignatureFile = path + "/2018-08/kwikset-doorlock/onSignature-Kwikset-Doorlock-phone-new.sig";
  53         final String offSignatureFile = path + "/2018-08/kwikset-doorlock/offSignature-Kwikset-Doorlock-phone-new.sig";
  54         */
  55
  56         // D-Link Plug experiment
  57         //final String inputPcapFile = path + "/evaluation/dlink/dlink-plug.data.wlan1.pcap";
  58 //        final String inputPcapFile = path + "/evaluation/dlink/dlink-plug.data.eth0.pcap";
  59
  60         // D-Link Plug DEVICE signatures
  61 //        final String onSignatureFile = path + "/2018-07/dlink/onSignature-DLink-Plug-device.sig";
  62 //        final String offSignatureFile = path + "/2018-07/dlink/offSignature-DLink-Plug-device.sig";
  63         // D-Link Plug PHONE signatures
  64 //        final String onSignatureFile = path + "/2018-07/dlink/onSignature-DLink-Plug-phone.sig";
  65 //        final String offSignatureFile = path + "/2018-07/dlink/offSignature-DLink-Plug-phone.sig";
  66
  67         // TODO: The following are negative tests against the PCAP file from UNSW
  68         /*        final String inputPcapFile = path + "/UNSW/16-09-28.pcap"; TODO: Seems to be broken! */
  69         /*        final String inputPcapFile = path + "/UNSW/16-10-02.pcap"; TODO: Seems to be broken! */
  70         /*        final String inputPcapFile = path + "/UNSW/16-10-03.pcap"; TODO: Seems to be broken! */
  71         /*        final String inputPcapFile = path + "/UNSW/16-10-04.pcap"; TODO: Seems to be broken! */
  72         /*        final String inputPcapFile = path + "/UNSW/16-10-07.pcap"; TODO: Seems to be broken! */
  73         /*        final String inputPcapFile = path + "/UNSW/16-10-08.pcap"; TODO: Seems to be broken! */
  74         /*        final String inputPcapFile = path + "/UNSW/16-10-09.pcap"; TODO: Seems to be broken! */
  75         /*        final String inputPcapFile = path + "/UNSW/16-10-10.pcap"; TODO: Seems to be broken! */
  76         /*        final String inputPcapFile = path + "/UNSW/16-10-11.pcap"; TODO: Seems to be broken! */
  77
  78
  79 //        final String inputPcapFile = path + "/UNSW/16-09-23.pcap";
  80 //        final String inputPcapFile = path + "/UNSW/16-09-24.pcap";
  81 //        final String inputPcapFile = path + "/UNSW/16-09-25.pcap";
  82 //        final String inputPcapFile = path + "/UNSW/16-09-26.pcap";
  83 //        final String inputPcapFile = path + "/UNSW/16-09-27.pcap";
  84 //        final String inputPcapFile = path + "/UNSW/16-09-29.pcap";
  85 //        final String inputPcapFile = path + "/UNSW/16-10-01.pcap";
  86 //        final String inputPcapFile = path + "/UNSW/16-10-06.pcap";
  87
  88         // TODO: The following one is very long!!!
  89 //        final String inputPcapFile = path + "/UNSW/16-10-12.pcap";
  90
  91         // TODO: The following are tests for signatures against training data
  92         /*
  93         // D-Link Plug experiment
  94         final String inputPcapFile = path + "/training/dlink-plug/wlan1/dlink-plug.wlan1.local.pcap";
  95         // D-Link Plug DEVICE signatures
  96         //final String onSignatureFile = path + "/training/dlink-plug/signatures/dlink-plug-onSignature-device-side.sig";
  97         //final String offSignatureFile = path + "/training/dlink-plug/signatures/dlink-plug-offSignature-device-side.sig";
  98         // D-Link Plug PHONE signatures
  99         final String onSignatureFile = path + "/training/dlink-plug/signatures/dlink-plug-onSignature-phone-side.sig";
 100         final String offSignatureFile = path + "/training/dlink-plug/signatures/dlink-plug-offSignature-phone-side.sig";
 101         */
 102         // TODO: EXPERIMENT - November 7, 2018
 103         // D-Link Plug experiment
 104         //final String inputPcapFile = path + "/experimental_result/standalone/dlink-plug/wlan1/dlink-plug.wlan1.local.pcap";
 105         //final String inputPcapFile = path + "/experimental_result/smarthome/dlink-plug/wlan1/dlink-plug.wlan1.detection.pcap";
 106         //final String inputPcapFile = path + "/experimental_result/smarthome/dlink-plug/eth0/dlink-plug.eth0.detection.pcap";
 107         // D-Link Plug DEVICE signatures
 108 //        final String onSignatureFile = path + "/experimental_result/standalone/dlink-plug/signatures/dlink-plug-onSignature-device-side.sig";
 109 //        final String offSignatureFile = path + "/experimental_result/standalone/dlink-plug/signatures/dlink-plug-offSignature-device-side.sig";
 110         // D-Link Plug PHONE signatures
 111         //final String onSignatureFile = path + "/experimental_result/standalone/dlink-plug/signatures/dlink-plug-onSignature-phone-side.sig";
 112         //final String offSignatureFile = path + "/experimental_result/standalone/dlink-plug/signatures/dlink-plug-offSignature-phone-side.sig";
 113
 114         // TODO: EXPERIMENT - November 9, 2018
 115         // D-Link Siren experiment
 116         //final String inputPcapFile = path + "/experimental_result/standalone/dlink-siren/wlan1/dlink-siren.wlan1.local.pcap";
 117         //final String inputPcapFile = path + "/experimental_result/smarthome/dlink-siren/wlan1/dlink-siren.wlan1.detection.pcap";
 118 //        final String inputPcapFile = path + "/experimental_result/smarthome/dlink-siren/eth0/dlink-siren.eth0.detection.pcap";
 119         // D-Link Siren DEVICE signatures
 120         // TODO: The device signature does not have pairs---only one packet which is 216, so we don't consider this as a signature
 121 //        final String onSignatureFile = path + "/experimental_result/standalone/dlink-siren/signatures/dlink-siren-onSignature-device-side.sig";
 122 //        final String offSignatureFile = path + "/experimental_result/standalone/dlink-siren/signatures/dlink-siren-offSignature-device-side.sig";
 123         // D-Link Siren PHONE signatures
 124 //        final String onSignatureFile = path + "/experimental_result/standalone/dlink-siren/signatures/dlink-siren-onSignature-phone-side.sig";
 125 //        final String offSignatureFile = path + "/experimental_result/standalone/dlink-siren/signatures/dlink-siren-offSignature-phone-side.sig";
 126
 127         // TP-Link Plug experiment
 128         //final String inputPcapFile = path + "/training/tplink-plug/wlan1/tplink-plug.wlan1.local.pcap";
 129         // TP-Link Plug DEVICE signatures
 130         //final String onSignatureFile = path + "/training/tplink-plug/signatures/tplink-plug-onSignature-device-side.sig";
 131         //final String offSignatureFile = path + "/training/tplink-plug/signatures/tplink-plug-offSignature-device-side.sig";
 132         // TODO: EXPERIMENT - November 8, 2018
 133         // TP-Link Plug experiment
 134 //        final String inputPcapFile = path + "/experimental_result/standalone/tplink-plug/wlan1/tplink-plug.wlan1.local.pcap";
 135 //        final String inputPcapFile = path + "/experimental_result/standalone/tplink-plug/eth0/tplink-plug.eth0.local.pcap";
 136 //        final String inputPcapFile = path + "/experimental_result/smarthome/tplink-plug/wlan1/tplink-plug.wlan1.detection.pcap";
 137         //final String inputPcapFile = path + "/experimental_result/smarthome/tplink-plug/eth0/tplink-plug.eth0.detection.pcap";
 138         // TP-Link Plug DEVICE signatures
 139 //        final String onSignatureFile = path + "/experimental_result/standalone/tplink-plug/signatures/tplink-plug-onSignature-device-side.sig";
 140 //        final String offSignatureFile = path + "/experimental_result/standalone/tplink-plug/signatures/tplink-plug-offSignature-device-side.sig";
 141 //        final String onSignatureFile = path + "/experimental_result/standalone/tplink-plug/signatures/tplink-plug-onSignature-device-side-outbound.sig";
 142 //        final String offSignatureFile = path + "/experimental_result/standalone/tplink-plug/signatures/tplink-plug-offSignature-device-side-outbound.sig";
 143         // TP-Link Plug PHONE signatures
 144 //        final String onSignatureFile = path + "/experimental_result/standalone/tplink-plug/signatures/tplink-plug-onSignature-phone-side.sig";
 145 //        final String offSignatureFile = path + "/experimental_result/standalone/tplink-plug/signatures/tplink-plug-offSignature-phone-side.sig";
 146
 147         // Arlo camera experiment
 148 //        final String inputPcapFile = path + "/training/arlo-camera/wlan1/arlo-camera.wlan1.local.pcap";
 149 //        // TP-Link Plug DEVICE signatures
 150 //        final String onSignatureFile = path + "/training/arlo-camera/signatures/arlo-camera-onSignature-phone-side.sig";
 151 //        final String offSignatureFile = path + "/training/arlo-camera/signatures/arlo-camera-offSignature-phone-side.sig";
 152
 153         // Amazon Alexa experiment
 154 //        final String inputPcapFile = path + "/training/amazon-alexa/wlan1/alexa2.wlan1.local.pcap";
 155 //        // TP-Link Plug DEVICE signatures
 156 //        final String onSignatureFile = path + "/training/amazon-alexa/signatures/amazon-alexa-onSignature-device-side.sig";
 157 //        final String offSignatureFile = path + "/training/amazon-alexa/signatures/amazon-alexa-offSignature-device-side.sig";
 158
 159         // SmartThings Plug experiment
 160 //        final String inputPcapFile = path + "/training/st-plug/wlan1/st-plug.wlan1.local.pcap";
 161 //        // TP-Link Plug DEVICE signatures
 162 //        //final String onSignatureFile = path + "/training/st-plug/signatures/st-plug-onSignature-device-side.sig";
 163 //        //final String offSignatureFile = path + "/training/st-plug/signatures/st-plug-offSignature-device-side.sig";
 164 //        // TP-Link Plug PHONE signatures
 165 //        final String onSignatureFile = path + "/training/st-plug/signatures/st-plug-onSignature-phone-side.sig";
 166 //        final String offSignatureFile = path + "/training/st-plug/signatures/st-plug-offSignature-phone-side.sig";
 167
 168
 169         // LiFX Bulb experiment
 170 //        final String inputPcapFile = path + "/training/lifx-bulb/wlan1/lifx-bulb.wlan1.local.pcap";
 171 //        // LiFX Bulb DEVICE signatures
 172 //        final String onSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-onSignature-device-side.sig";
 173 //        final String offSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-offSignature-device-side.sig";
 174         // LiFX Bulb PHONE signatures
 175 //        final String onSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-onSignature-phone-side.sig";
 176 //        final String offSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-offSignature-phone-side.sig";
 177
 178
 179         /*
 180         // Blossom Sprinkler experiment
 181         //final String inputPcapFile = path + "/training/blossom-sprinkler/wlan1/blossom-sprinkler.wlan1.local.pcap";
 182         final String inputPcapFile = path + "/training/blossom-sprinkler/eth0/blossom-sprinkler.eth0.local.pcap";
 183         // Blossom Sprinkler DEVICE signatures
 184         final String onSignatureFile = path + "/training/blossom-sprinkler/signatures/blossom-sprinkler-onSignature-device-side.sig";
 185         final String offSignatureFile = path + "/training/blossom-sprinkler/signatures/blossom-sprinkler-offSignature-device-side.sig";
 186         */
 187
 188         // Nest Thermostat experiment
 189 //        final String inputPcapFile = path + "/training/nest-thermostat/wlan1/nest-thermostat.wlan1.local.pcap";
 190 //        // Nest Thermostat DEVICE signatures
 191 ////        final String onSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-onSignature-device-side.sig";
 192 ////        final String offSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-offSignature-device-side.sig";
 193 //        // Nest Thermostat PHONE signatures
 194 //        final String onSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-onSignature-phone-side.sig";
 195 //        final String offSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-offSignature-phone-side.sig";
 196
 197         /*
 198         // Hue Bulb experiment
 199         final String inputPcapFile = path + "/training/hue-bulb/wlan1/hue-bulb.wlan1.local.pcap";
 200         // Hue Bulb PHONE signatures
 201         final String onSignatureFile = path + "/training/hue-bulb/signatures/hue-bulb-onSignature-phone-side.sig";
 202         final String offSignatureFile = path + "/training/hue-bulb/signatures/hue-bulb-offSignature-phone-side.sig";
 203         */
 204
 205         /*
 206         // TP-Link Bulb experiment
 207         final String inputPcapFile = path + "/training/tplink-bulb/wlan1/tplink-bulb.wlan1.local.pcap";
 208         // TP-Link Bulb PHONE signatures
 209         final String onSignatureFile = path + "/training/tplink-bulb/signatures/tplink-bulb-onSignature-phone-side.sig";
 210         final String offSignatureFile = path + "/training/tplink-bulb/signatures/tplink-bulb-offSignature-phone-side.sig";
 211         */
 212
 213         /*
 214         // WeMo Plug experiment
 215         final String inputPcapFile = path + "/training/wemo-plug/wlan1/wemo-plug.wlan1.local.pcap";
 216         // WeMo Plug PHONE signatures
 217         final String onSignatureFile = path + "/training/wemo-plug/signatures/wemo-plug-onSignature-device-side.sig";
 218         final String offSignatureFile = path + "/training/wemo-plug/signatures/wemo-plug-offSignature-device-side.sig";
 219         */
 220
 221         /*
 222         // WeMo Insight Plug experiment
 223         final String inputPcapFile = path + "/training/wemo-insight-plug/wlan1/wemo-insight-plug.wlan1.local.pcap";
 224         // WeMo Insight Plug PHONE signatures
 225         final String onSignatureFile = path + "/training/wemo-insight-plug/signatures/wemo-insight-plug-onSignature-device-side.sig";
 226         final String offSignatureFile = path + "/training/wemo-insight-plug/signatures/wemo-insight-plug-offSignature-device-side.sig";
 227         */
 228
 229
 230         // Kwikset Doorlock Sep 12 experiment
 231 //        final String inputPcapFile = path + "/2018-08/kwikset-doorlock/kwikset3.wlan1.local.pcap";
 232 //        // Kwikset Doorlock PHONE signatures
 233 //        final String onSignatureFile = path + "/2018-08/kwikset-doorlock/onSignature-Kwikset-Doorlock-phone.sig";
 234 //        final String offSignatureFile = path + "/2018-08/kwikset-doorlock/offSignature-Kwikset-Doorlock-phone.sig";
 235         // TODO: EXPERIMENT - November 10, 2018
 236         // Kwikset Door lock experiment
 237 //        final String inputPcapFile = path + "/experimental_result/standalone/kwikset-doorlock/wlan1/kwikset-doorlock.wlan1.local.pcap";
 238 //        //final String inputPcapFile = path + "/experimental_result/smarthome/kwikset-doorlock/wlan1/kwikset-doorlock.wlan1.detection.pcap";
 239 ////        final String inputPcapFile = path + "/experimental_result/smarthome/kwikset-doorlock/eth0/kwikset-doorlock.eth0.detection.pcap";
 240 //        // Kwikset Door lock PHONE signatures
 241 //        final String onSignatureFile = path + "/experimental_result/standalone/kwikset-doorlock/signatures/kwikset-doorlock-onSignature-phone-side.sig";
 242 //        final String offSignatureFile = path + "/experimental_result/standalone/kwikset-doorlock/signatures/kwikset-doorlock-offSignature-phone-side.sig";
 243
 244
 245
 246         /*
 247         // D-Link Siren experiment
 248         final String inputPcapFile = path + "/2018-08/dlink-siren/dlink-siren.wlan1.local.pcap";
 249         // D-Link Siren DEVICE signatures
 250         //final String onSignatureFile = path + "/2018-08/dlink-siren/onSignature-DLink-Siren-device.sig";
 251         //final String offSignatureFile = path + "/2018-08/dlink-siren/offSignature-DLink-Siren-device.sig";
 252         // D-Link Siren PHONE signatures
 253         final String onSignatureFile = path + "/2018-08/dlink-siren/onSignature-DLink-Siren-phone.sig";
 254         final String offSignatureFile = path + "/2018-08/dlink-siren/offSignature-DLink-Siren-phone.sig";
 255         */
 256
 257         List<List<List<PcapPacket>>> onSignature = PrintUtils.deserializeSignatureFromFile(onSignatureFile);
 258         List<List<List<PcapPacket>>> offSignature = PrintUtils.deserializeSignatureFromFile(offSignatureFile);
 259
 260         // LAN
 261 //        SignatureDetector onDetector = new SignatureDetector(onSignature, null);
 262 //        SignatureDetector offDetector = new SignatureDetector(offSignature, null);
 263         // WAN
 264         SignatureDetector onDetector = new SignatureDetector(onSignature, "128.195.205.105");
 265         SignatureDetector offDetector = new SignatureDetector(offSignature, "128.195.205.105");
 266
 267         final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM).
 268                 withLocale(Locale.US).withZone(ZoneId.of("America/Los_Angeles"));
 269
 270         // Outputs information about a detected event to std.out
 271         final Consumer<UserAction> outputter = ua -> {
 272             String eventDescription;
 273             switch (ua.getType()) {
 274                 case TOGGLE_ON:
 275                     eventDescription = "ON";
 276                     break;
 277                 case TOGGLE_OFF:
 278                     eventDescription = "OFF";
 279                     break;
 280                 default:
 281                     throw new AssertionError("unhandled event type");
 282             }
 283             //String output = String.format("[ !!! %s SIGNATURE DETECTED at %s !!! ]",
 284             //      eventDescription, dateTimeFormatter.format(ua.getTimestamp()));
 285             String output = String.format("%s",
 286                     dateTimeFormatter.format(ua.getTimestamp()));
 287             System.out.println(output);
 288         };
 289
 290         // Let's create observers that construct a UserAction representing the detected event.
 291         final List<UserAction> detectedEvents = new ArrayList<>();
 292         onDetector.addObserver((searched, match) -> {
 293             PcapPacket firstPkt = match.get(0).get(0);
 294             detectedEvents.add(new UserAction(UserAction.Type.TOGGLE_ON, firstPkt.getTimestamp()));
 295         });
 296         offDetector.addObserver((searched, match) -> {
 297             PcapPacket firstPkt = match.get(0).get(0);
 298             detectedEvents.add(new UserAction(UserAction.Type.TOGGLE_OFF, firstPkt.getTimestamp()));
 299         });
 300
 301         PcapHandle handle;
 302         try {
 303             handle = Pcaps.openOffline(inputPcapFile, PcapHandle.TimestampPrecision.NANO);
 304         } catch (PcapNativeException pne) {
 305             handle = Pcaps.openOffline(inputPcapFile);
 306         }
 307         PcapHandleReader reader = new PcapHandleReader(handle, p -> true, onDetector, offDetector);
 308         reader.readFromHandle();
 309
 310         // TODO: need a better way of triggering detection than this...
 311         onDetector.mClusterMatchers.forEach(cm -> cm.performDetection());
 312         offDetector.mClusterMatchers.forEach(cm -> cm.performDetection());
 313
 314         // Sort the list of detected events by timestamp to make it easier to compare it line-by-line with the trigger
 315         // times file.
 316         Collections.sort(detectedEvents, Comparator.comparing(UserAction::getTimestamp));
 317
 318
 319         // Output the detected events
 320         //detectedEvents.forEach(outputter);
 321
 322         // TODO: Temporary clean up until we clean the pipeline
 323         List<UserAction> cleanedDetectedEvents = SignatureDetector.removeDuplicates(detectedEvents);
 324         cleanedDetectedEvents.forEach(outputter);
 325     }
 326
 327     /**
 328      * The signature that this {@link SignatureDetector} is searching for.
 329      */
 330     private final List<List<List<PcapPacket>>> mSignature;
 331
 332     /**
 333      * The {@link ClusterMatcher}s in charge of detecting each individual sequence of packets that together make up the
 334      * the signature.
 335      */
 336     private final List<ClusterMatcher> mClusterMatchers;
 337
 338     /**
 339      * For each {@code i} ({@code i >= 0 && i < pendingMatches.length}), {@code pendingMatches[i]} holds the matches
 340      * found by the {@link ClusterMatcher} at {@code mClusterMatchers.get(i)} that have yet to be "consumed", i.e.,
 341      * have yet to be included in a signature detected by this {@link SignatureDetector} (a signature can be encompassed
 342      * of multiple packet sequences occurring shortly after one another on multiple connections).
 343      */
 344     private final List<List<PcapPacket>>[] pendingMatches;
 345
 346     /**
 347      * Maps a {@link ClusterMatcher} to its corresponding index in {@link #pendingMatches}.
 348      */
 349     private final Map<ClusterMatcher, Integer> mClusterMatcherIds;
 350
 351     private final List<SignatureDetectionObserver> mObservers = new ArrayList<>();
 352
 353     /**
 354      * Remove duplicates in {@code List} of {@code UserAction} objects. We need to clean this up for user actions
 355      * that appear multiple times.
 356      * TODO: This static method is probably just for temporary and we could get rid of this after we clean up
 357      * TODO:    the pipeline
 358      *
 359      * @param listUserAction A {@link List} of {@code UserAction}.
 360      *
 361      */
 362     public static List<UserAction> removeDuplicates(List<UserAction> listUserAction) {
 363
 364         // Iterate and check for duplicates (check timestamps)
 365         Set<Long> epochSecondSet = new HashSet<>();
 366         // Create a target list for cleaned up list
 367         List<UserAction> listUserActionClean = new ArrayList<>();
 368         for(UserAction userAction : listUserAction) {
 369             // Don't insert if any duplicate is found
 370             if(!epochSecondSet.contains(userAction.getTimestamp().getEpochSecond())) {
 371                 listUserActionClean.add(userAction);
 372                 epochSecondSet.add(userAction.getTimestamp().getEpochSecond());
 373             }
 374         }
 375         return listUserActionClean;
 376     }
 377
 378     public SignatureDetector(List<List<List<PcapPacket>>> searchedSignature, String routerWanIp) {
 379         // note: doesn't protect inner lists from changes :'(
 380         mSignature = Collections.unmodifiableList(searchedSignature);
 381         // Generate corresponding/appropriate ClusterMatchers based on the provided signature
 382         List<ClusterMatcher> clusterMatchers = new ArrayList<>();
 383         for (List<List<PcapPacket>> cluster : mSignature) {
 384             clusterMatchers.add(new ClusterMatcher(cluster, routerWanIp, this));
 385         }
 386         mClusterMatchers = Collections.unmodifiableList(clusterMatchers);
 387
 388         // < exploratory >
 389         pendingMatches = new List[mClusterMatchers.size()];
 390         for (int i = 0; i < pendingMatches.length; i++) {
 391             pendingMatches[i] = new ArrayList<>();
 392         }
 393         Map<ClusterMatcher, Integer> clusterMatcherIds = new HashMap<>();
 394         for (int i = 0; i < mClusterMatchers.size(); i++) {
 395             clusterMatcherIds.put(mClusterMatchers.get(i), i);
 396         }
 397         mClusterMatcherIds = Collections.unmodifiableMap(clusterMatcherIds);
 398     }
 399
 400     public void addObserver(SignatureDetectionObserver observer) {
 401         mObservers.add(observer);
 402     }
 403
 404     public boolean removeObserver(SignatureDetectionObserver observer) {
 405         return mObservers.remove(observer);
 406     }
 407
 408     @Override
 409     public void gotPacket(PcapPacket packet) {
 410         // simply delegate packet reception to all ClusterMatchers.
 411         mClusterMatchers.forEach(cm -> cm.gotPacket(packet));
 412     }
 413
 414     @Override
 415     public void onMatch(ClusterMatcher clusterMatcher, List<PcapPacket> match) {
 416         // Add the match at the corresponding index
 417         pendingMatches[mClusterMatcherIds.get(clusterMatcher)].add(match);
 418         checkSignatureMatch();
 419     }
 420
 421     private void checkSignatureMatch() {
 422         // << Graph-based approach using Balint's idea. >>
 423         // This implementation assumes that the packets in the inner lists (the sequences) are ordered by asc timestamp.
 424
 425         // There cannot be a signature match until each ClusterMatcher has found a match of its respective sequence.
 426         if (Arrays.stream(pendingMatches).noneMatch(l -> l.isEmpty())) {
 427             // Construct the DAG
 428             final SimpleDirectedWeightedGraph<Vertex, DefaultWeightedEdge> graph =
 429                     new SimpleDirectedWeightedGraph<>(DefaultWeightedEdge.class);
 430             // Add a vertex for each match found by all ClusterMatchers
 431             // And maintain an array to keep track of what cluster matcher each vertex corresponds to
 432             final List<Vertex>[] vertices = new List[pendingMatches.length];
 433             for (int i = 0; i < pendingMatches.length; i++) {
 434                 vertices[i] = new ArrayList<>();
 435                 for (List<PcapPacket> sequence : pendingMatches[i]) {
 436                     Vertex v = new Vertex(sequence);
 437                     vertices[i].add(v); // retain reference for later when we are to add edges
 438                     graph.addVertex(v); // add to vertex to graph
 439                 }
 440             }
 441             // Add dummy source and sink vertices to facilitate search.
 442             final Vertex source = new Vertex(null);
 443             final Vertex sink = new Vertex(null);
 444             graph.addVertex(source);
 445             graph.addVertex(sink);
 446             // The source is connected to all vertices that wrap the sequences detected by ClusterMatcher at index 0.
 447             // Note: zero cost edges as this is just a dummy link to facilitate search from a common start node.
 448             for (Vertex v : vertices[0]) {
 449                 DefaultWeightedEdge edge = graph.addEdge(source, v);
 450                 graph.setEdgeWeight(edge, 0.0);
 451             }
 452             // Similarly, all vertices that wrap the sequences detected by the last ClusterMatcher of the signature
 453             // are connected to the sink node.
 454             for (Vertex v : vertices[vertices.length-1]) {
 455                 DefaultWeightedEdge edge = graph.addEdge(v, sink);
 456                 graph.setEdgeWeight(edge, 0.0);
 457             }
 458             // Now link sequences detected by ClusterMatcher at index i to sequences detected by ClusterMatcher at index
 459             // i+1 if they obey the timestamp constraint (i.e., that the latter is later in time than the former).
 460             for (int i = 0; i < vertices.length; i++) {
 461                 int j = i + 1;
 462                 if (j < vertices.length) {
 463                     for (Vertex iv : vertices[i]) {
 464                         PcapPacket ivLast = iv.sequence.get(iv.sequence.size()-1);
 465                         for (Vertex jv : vertices[j]) {
 466                             PcapPacket jvFirst = jv.sequence.get(jv.sequence.size()-1);
 467                             if (ivLast.getTimestamp().isBefore(jvFirst.getTimestamp())) {
 468                                 DefaultWeightedEdge edge = graph.addEdge(iv, jv);
 469                                 // The weight is the duration of the i'th sequence plus the duration between the i'th
 470                                 // and i+1'th sequence.
 471                                 Duration d = Duration.
 472                                         between(iv.sequence.get(0).getTimestamp(), jvFirst.getTimestamp());
 473                                 // Unfortunately weights are double values, so must convert from long to double.
 474                                 // TODO: need nano second precision? If so, use d.toNanos().
 475                                 // TODO: risk of overflow when converting from long to double..?
 476                                 graph.setEdgeWeight(edge, Long.valueOf(d.toMillis()).doubleValue());
 477                             }
 478                             // Alternative version if we cannot assume that sequences are ordered by timestamp:
 479 //                            if (iv.sequence.stream().max(Comparator.comparing(PcapPacket::getTimestamp)).get()
 480 //                                    .getTimestamp().isBefore(jv.sequence.stream().min(
 481 //                                            Comparator.comparing(PcapPacket::getTimestamp)).get().getTimestamp())) {
 482 //
 483 //                            }
 484                         }
 485                     }
 486                 }
 487             }
 488             // Graph construction complete, run shortest-path to find a (potential) signature match.
 489             DijkstraShortestPath<Vertex, DefaultWeightedEdge> dijkstra = new DijkstraShortestPath<>(graph);
 490             GraphPath<Vertex, DefaultWeightedEdge> shortestPath = dijkstra.getPath(source, sink);
 491             if (shortestPath != null) {
 492                 // The total weight is the duration between the first packet of the first sequence and the last packet
 493                 // of the last sequence, so we simply have to compare the weight against the timeframe that we allow
 494                 // the signature to span. For now we just use the inclusion window we defined for training purposes.
 495                 // Note however, that we must convert back from double to long as the weight is stored as a double in
 496                 // JGraphT's API.
 497                 if (((long)shortestPath.getWeight()) < TriggerTrafficExtractor.INCLUSION_WINDOW_MILLIS) {
 498                     // There's a signature match!
 499                     // Extract the match from the vertices
 500                     List<List<PcapPacket>> signatureMatch = new ArrayList<>();
 501                     for(Vertex v : shortestPath.getVertexList()) {
 502                         if (v == source || v == sink) {
 503                             // Skip the dummy source and sink nodes.
 504                             continue;
 505                         }
 506                         signatureMatch.add(v.sequence);
 507                         // As there is a one-to-one correspondence between vertices[] and pendingMatches[], we know that
 508                         // the sequence we've "consumed" for index i of the matched signature is also at index i in
 509                         // pendingMatches. We must remove it from pendingMatches so that we don't use it to construct
 510                         // another signature match in a later call.
 511                         pendingMatches[signatureMatch.size()-1].remove(v.sequence);
 512                     }
 513                     // Declare success: notify observers
 514                     mObservers.forEach(obs -> obs.onSignatureDetected(mSignature,
 515                             Collections.unmodifiableList(signatureMatch)));
 516                 }
 517             }
 518         }
 519     }
 520
 521     /**
 522      * Used for registering for notifications of signatures detected by a {@link SignatureDetector}.
 523      */
 524     interface SignatureDetectionObserver {
 525
 526         /**
 527          * Invoked when the {@link SignatureDetector} detects the presence of a signature in the traffic that it's
 528          * examining.
 529          * @param searchedSignature The signature that the {@link SignatureDetector} reporting the match is searching
 530          *                          for.
 531          * @param matchingTraffic The actual traffic trace that matches the searched signature.
 532          */
 533         void onSignatureDetected(List<List<List<PcapPacket>>> searchedSignature,
 534                                  List<List<PcapPacket>> matchingTraffic);
 535     }
 536
 537     /**
 538      * Encapsulates a {@code List<PcapPacket>} so as to allow the list to be used as a vertex in a graph while avoiding
 539      * the expensive {@link AbstractList#equals(Object)} calls when adding vertices to the graph.
 540      * Using this wrapper makes the incurred {@code equals(Object)} calls delegate to {@link Object#equals(Object)}
 541      * instead of {@link AbstractList#equals(Object)}. The net effect is a faster implementation, but the graph will not
 542      * recognize two lists that contain the same items--from a value and not reference point of view--as the same
 543      * vertex. However, this is fine for our purposes -- in fact restricting it to reference equality seems more
 544      * appropriate.
 545      */
 546     private static class Vertex {
 547         private final List<PcapPacket> sequence;
 548         private Vertex(List<PcapPacket> wrappedSequence) {
 549             sequence = wrappedSequence;
 550         }
 551     }
 552 }