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         // TODO: EXPERIMENT - November 13, 2018
 153         // Arlo Camera experiment
 154 //        final String inputPcapFile = path + "/experimental_result/standalone/arlo-camera/wlan1/arlo-camera.wlan1.local.pcap";
 155 //        final String inputPcapFile = path + "/experimental_result/standalone/arlo-camera/eth0/arlo-camera.eth0.local.pcap";
 156 //        final String inputPcapFile = path + "/experimental_result/smarthome/arlo-camera/wlan1/arlo-camera.wlan1.detection.pcap";
 157 //        final String inputPcapFile = path + "/experimental_result/smarthome/arlo-camera/eth0/arlo-camera.eth0.detection.pcap";
 158 //        final String inputPcapFile = path + "/training/arlo-camera/eth0/arlo-camera.eth0.local.pcap";
 159         // Arlo Camera PHONE signatures
 160 //        final String onSignatureFile = path + "/experimental_result/standalone/arlo-camera/signatures/arlo-camera-onSignature-phone-side.sig";
 161 //        final String offSignatureFile = path + "/experimental_result/standalone/arlo-camera/signatures/arlo-camera-offSignature-phone-side.sig";
 162
 163         // Amazon Alexa experiment
 164 //        final String inputPcapFile = path + "/training/amazon-alexa/wlan1/alexa2.wlan1.local.pcap";
 165 //        // TP-Link Plug DEVICE signatures
 166 //        final String onSignatureFile = path + "/training/amazon-alexa/signatures/amazon-alexa-onSignature-device-side.sig";
 167 //        final String offSignatureFile = path + "/training/amazon-alexa/signatures/amazon-alexa-offSignature-device-side.sig";
 168
 169         // SmartThings Plug experiment
 170 //        final String inputPcapFile = path + "/training/st-plug/wlan1/st-plug.wlan1.local.pcap";
 171 //        // SmartThings Plug DEVICE signatures
 172 //        //final String onSignatureFile = path + "/training/st-plug/signatures/st-plug-onSignature-device-side.sig";
 173 //        //final String offSignatureFile = path + "/training/st-plug/signatures/st-plug-offSignature-device-side.sig";
 174 //        // SmartThings Plug PHONE signatures
 175 //        final String onSignatureFile = path + "/training/st-plug/signatures/st-plug-onSignature-phone-side.sig";
 176 //        final String offSignatureFile = path + "/training/st-plug/signatures/st-plug-offSignature-phone-side.sig";
 177         // TODO: EXPERIMENT - November 12, 2018
 178         // SmartThings Plug experiment
 179 //        final String inputPcapFile = path + "/experimental_result/standalone/st-plug/wlan1/st-plug.wlan1.local.pcap";
 180 //        final String inputPcapFile = path + "/experimental_result/standalone/st-plug/eth0/st-plug.eth0.local.pcap";
 181 //        //final String inputPcapFile = path + "/experimental_result/smarthome/st-plug/wlan1/st-plug.wlan1.detection.pcap";
 182 //        final String inputPcapFile = path + "/experimental_result/smarthome/st-plug/eth0/st-plug.eth0.detection.pcap";
 183 //        // SmartThings Plug PHONE signatures
 184 //        final String onSignatureFile = path + "/experimental_result/standalone/st-plug/signatures/st-plug-onSignature-phone-side.sig";
 185 //        final String offSignatureFile = path + "/experimental_result/standalone/st-plug/signatures/st-plug-offSignature-phone-side.sig";
 186
 187
 188         // LiFX Bulb experiment
 189 //        final String inputPcapFile = path + "/training/lifx-bulb/wlan1/lifx-bulb.wlan1.local.pcap";
 190 //        // LiFX Bulb DEVICE signatures
 191 //        final String onSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-onSignature-device-side.sig";
 192 //        final String offSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-offSignature-device-side.sig";
 193         // LiFX Bulb PHONE signatures
 194 //        final String onSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-onSignature-phone-side.sig";
 195 //        final String offSignatureFile = path + "/training/lifx-bulb/signatures/lifx-bulb-offSignature-phone-side.sig";
 196
 197
 198         /*
 199         // Blossom Sprinkler experiment
 200         //final String inputPcapFile = path + "/training/blossom-sprinkler/wlan1/blossom-sprinkler.wlan1.local.pcap";
 201         final String inputPcapFile = path + "/training/blossom-sprinkler/eth0/blossom-sprinkler.eth0.local.pcap";
 202         // Blossom Sprinkler DEVICE signatures
 203         final String onSignatureFile = path + "/training/blossom-sprinkler/signatures/blossom-sprinkler-onSignature-device-side.sig";
 204         final String offSignatureFile = path + "/training/blossom-sprinkler/signatures/blossom-sprinkler-offSignature-device-side.sig";
 205         */
 206
 207         // Nest Thermostat experiment
 208 //        final String inputPcapFile = path + "/training/nest-thermostat/wlan1/nest-thermostat.wlan1.local.pcap";
 209 //        // Nest Thermostat DEVICE signatures
 210 ////        final String onSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-onSignature-device-side.sig";
 211 ////        final String offSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-offSignature-device-side.sig";
 212 //        // Nest Thermostat PHONE signatures
 213 //        final String onSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-onSignature-phone-side.sig";
 214 //        final String offSignatureFile = path + "/training/nest-thermostat/signatures/nest-thermostat-offSignature-phone-side.sig";
 215         // TODO: EXPERIMENT - November 15, 2018
 216         // Nest Thermostat experiment
 217 //        final String inputPcapFile = path + "/experimental_result/standalone/nest-thermostat/wlan1/nest-thermostat.wlan1.local.pcap";
 218 ////        final String inputPcapFile = path + "/experimental_result/standalone/nest-thermostat/eth0/nest-thermostat.eth0.local.pcap";
 219 ////        final String inputPcapFile = path + "/experimental_result/smarthome/nest-thermostat/wlan1/nest-thermostat.wlan1.detection.pcap";
 220 //        final String inputPcapFile = path + "/experimental_result/smarthome/nest-thermostat/eth0/nest-thermostat.eth0.detection.pcap";
 221 ////        // Nest Thermostat PHONE signatures
 222 //        final String onSignatureFile = path + "/experimental_result/standalone/nest-thermostat/signatures/nest-thermostat-onSignature-phone-side.sig";
 223 //        final String offSignatureFile = path + "/experimental_result/standalone/nest-thermostat/signatures/nest-thermostat-offSignature-phone-side.sig";
 224
 225         /*
 226         // Hue Bulb experiment
 227         final String inputPcapFile = path + "/training/hue-bulb/wlan1/hue-bulb.wlan1.local.pcap";
 228         // Hue Bulb PHONE signatures
 229         final String onSignatureFile = path + "/training/hue-bulb/signatures/hue-bulb-onSignature-phone-side.sig";
 230         final String offSignatureFile = path + "/training/hue-bulb/signatures/hue-bulb-offSignature-phone-side.sig";
 231         */
 232
 233
 234         // TP-Link Bulb experiment
 235 //        final String inputPcapFile = path + "/training/tplink-bulb/wlan1/tplink-bulb.wlan1.local.pcap";
 236 //        // TP-Link Bulb PHONE signatures
 237 //        final String onSignatureFile = path + "/training/tplink-bulb/signatures/tplink-bulb-onSignature-phone-side.sig";
 238 //        final String offSignatureFile = path + "/training/tplink-bulb/signatures/tplink-bulb-offSignature-phone-side.sig";
 239         // TODO: EXPERIMENT - November 16, 2018
 240         // TP-Link Bulb experiment
 241         final String inputPcapFile = path + "/experimental_result/standalone/tplink-bulb/wlan1/tplink-bulb.wlan1.local.pcap";
 242 //        final String inputPcapFile = path + "/experimental_result/standalone/tplink-bulb/eth0/tplink-bulb.eth0.local.pcap";
 243 //        final String inputPcapFile = path + "/experimental_result/smarthome/tplink-bulb/wlan1/tplink-bulb.wlan1.detection.pcap";
 244 //        final String inputPcapFile = path + "/experimental_result/smarthome/tplink-bulb/eth0/tplink-bulb.eth0.detection.pcap";
 245 //        // TP-Link Bulb PHONE signatures
 246         final String onSignatureFile = path + "/experimental_result/standalone/tplink-bulb/signatures/tplink-bulb-onSignature-phone-side.sig";
 247         final String offSignatureFile = path + "/experimental_result/standalone/tplink-bulb/signatures/tplink-bulb-offSignature-phone-side.sig";
 248
 249         /*
 250         // WeMo Plug experiment
 251         final String inputPcapFile = path + "/training/wemo-plug/wlan1/wemo-plug.wlan1.local.pcap";
 252         // WeMo Plug PHONE signatures
 253         final String onSignatureFile = path + "/training/wemo-plug/signatures/wemo-plug-onSignature-device-side.sig";
 254         final String offSignatureFile = path + "/training/wemo-plug/signatures/wemo-plug-offSignature-device-side.sig";
 255         */
 256
 257         /*
 258         // WeMo Insight Plug experiment
 259         final String inputPcapFile = path + "/training/wemo-insight-plug/wlan1/wemo-insight-plug.wlan1.local.pcap";
 260         // WeMo Insight Plug PHONE signatures
 261         final String onSignatureFile = path + "/training/wemo-insight-plug/signatures/wemo-insight-plug-onSignature-device-side.sig";
 262         final String offSignatureFile = path + "/training/wemo-insight-plug/signatures/wemo-insight-plug-offSignature-device-side.sig";
 263         */
 264
 265
 266         // Kwikset Doorlock Sep 12 experiment
 267 //        final String inputPcapFile = path + "/2018-08/kwikset-doorlock/kwikset3.wlan1.local.pcap";
 268 //        // Kwikset Doorlock PHONE signatures
 269 //        final String onSignatureFile = path + "/2018-08/kwikset-doorlock/onSignature-Kwikset-Doorlock-phone.sig";
 270 //        final String offSignatureFile = path + "/2018-08/kwikset-doorlock/offSignature-Kwikset-Doorlock-phone.sig";
 271         // TODO: EXPERIMENT - November 10, 2018
 272         // Kwikset Door lock experiment
 273 //        final String inputPcapFile = path + "/experimental_result/standalone/kwikset-doorlock/wlan1/kwikset-doorlock.wlan1.local.pcap";
 274 //        //final String inputPcapFile = path + "/experimental_result/smarthome/kwikset-doorlock/wlan1/kwikset-doorlock.wlan1.detection.pcap";
 275 //        final String inputPcapFile = path + "/experimental_result/smarthome/kwikset-doorlock/eth0/kwikset-doorlock.eth0.detection.pcap";
 276 ////        // Kwikset Door lock PHONE signatures
 277 //        final String onSignatureFile = path + "/experimental_result/standalone/kwikset-doorlock/signatures/kwikset-doorlock-onSignature-phone-side.sig";
 278 //        final String offSignatureFile = path + "/experimental_result/standalone/kwikset-doorlock/signatures/kwikset-doorlock-offSignature-phone-side.sig";
 279
 280
 281
 282         /*
 283         // D-Link Siren experiment
 284         final String inputPcapFile = path + "/2018-08/dlink-siren/dlink-siren.wlan1.local.pcap";
 285         // D-Link Siren DEVICE signatures
 286         //final String onSignatureFile = path + "/2018-08/dlink-siren/onSignature-DLink-Siren-device.sig";
 287         //final String offSignatureFile = path + "/2018-08/dlink-siren/offSignature-DLink-Siren-device.sig";
 288         // D-Link Siren PHONE signatures
 289         final String onSignatureFile = path + "/2018-08/dlink-siren/onSignature-DLink-Siren-phone.sig";
 290         final String offSignatureFile = path + "/2018-08/dlink-siren/offSignature-DLink-Siren-phone.sig";
 291         */
 292
 293         List<List<List<PcapPacket>>> onSignature = PrintUtils.deserializeSignatureFromFile(onSignatureFile);
 294         List<List<List<PcapPacket>>> offSignature = PrintUtils.deserializeSignatureFromFile(offSignatureFile);
 295
 296         // LAN
 297 //        SignatureDetector onDetector = new SignatureDetector(onSignature, null);
 298 //        SignatureDetector offDetector = new SignatureDetector(offSignature, null);
 299         // WAN
 300         SignatureDetector onDetector = new SignatureDetector(onSignature, "128.195.205.105");
 301         SignatureDetector offDetector = new SignatureDetector(offSignature, "128.195.205.105");
 302
 303         final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofLocalizedDateTime(FormatStyle.MEDIUM).
 304                 withLocale(Locale.US).withZone(ZoneId.of("America/Los_Angeles"));
 305
 306         // Outputs information about a detected event to std.out
 307         final Consumer<UserAction> outputter = ua -> {
 308             String eventDescription;
 309             switch (ua.getType()) {
 310                 case TOGGLE_ON:
 311                     eventDescription = "ON";
 312                     break;
 313                 case TOGGLE_OFF:
 314                     eventDescription = "OFF";
 315                     break;
 316                 default:
 317                     throw new AssertionError("unhandled event type");
 318             }
 319             //String output = String.format("[ !!! %s SIGNATURE DETECTED at %s !!! ]",
 320             //      eventDescription, dateTimeFormatter.format(ua.getTimestamp()));
 321             String output = String.format("%s",
 322                     dateTimeFormatter.format(ua.getTimestamp()));
 323             System.out.println(output);
 324         };
 325
 326         // Let's create observers that construct a UserAction representing the detected event.
 327         final List<UserAction> detectedEvents = new ArrayList<>();
 328         onDetector.addObserver((searched, match) -> {
 329             PcapPacket firstPkt = match.get(0).get(0);
 330             detectedEvents.add(new UserAction(UserAction.Type.TOGGLE_ON, firstPkt.getTimestamp()));
 331         });
 332         offDetector.addObserver((searched, match) -> {
 333             PcapPacket firstPkt = match.get(0).get(0);
 334             detectedEvents.add(new UserAction(UserAction.Type.TOGGLE_OFF, firstPkt.getTimestamp()));
 335         });
 336
 337         PcapHandle handle;
 338         try {
 339             handle = Pcaps.openOffline(inputPcapFile, PcapHandle.TimestampPrecision.NANO);
 340         } catch (PcapNativeException pne) {
 341             handle = Pcaps.openOffline(inputPcapFile);
 342         }
 343         PcapHandleReader reader = new PcapHandleReader(handle, p -> true, onDetector, offDetector);
 344         reader.readFromHandle();
 345
 346         // TODO: need a better way of triggering detection than this...
 347         onDetector.mClusterMatchers.forEach(cm -> cm.performDetection());
 348         offDetector.mClusterMatchers.forEach(cm -> cm.performDetection());
 349
 350         // Sort the list of detected events by timestamp to make it easier to compare it line-by-line with the trigger
 351         // times file.
 352         Collections.sort(detectedEvents, Comparator.comparing(UserAction::getTimestamp));
 353
 354
 355         // Output the detected events
 356         //detectedEvents.forEach(outputter);
 357
 358         // TODO: Temporary clean up until we clean the pipeline
 359         List<UserAction> cleanedDetectedEvents = SignatureDetector.removeDuplicates(detectedEvents);
 360         cleanedDetectedEvents.forEach(outputter);
 361     }
 362
 363     /**
 364      * The signature that this {@link SignatureDetector} is searching for.
 365      */
 366     private final List<List<List<PcapPacket>>> mSignature;
 367
 368     /**
 369      * The {@link ClusterMatcher}s in charge of detecting each individual sequence of packets that together make up the
 370      * the signature.
 371      */
 372     private final List<ClusterMatcher> mClusterMatchers;
 373
 374     /**
 375      * For each {@code i} ({@code i >= 0 && i < pendingMatches.length}), {@code pendingMatches[i]} holds the matches
 376      * found by the {@link ClusterMatcher} at {@code mClusterMatchers.get(i)} that have yet to be "consumed", i.e.,
 377      * have yet to be included in a signature detected by this {@link SignatureDetector} (a signature can be encompassed
 378      * of multiple packet sequences occurring shortly after one another on multiple connections).
 379      */
 380     private final List<List<PcapPacket>>[] pendingMatches;
 381
 382     /**
 383      * Maps a {@link ClusterMatcher} to its corresponding index in {@link #pendingMatches}.
 384      */
 385     private final Map<ClusterMatcher, Integer> mClusterMatcherIds;
 386
 387     private final List<SignatureDetectionObserver> mObservers = new ArrayList<>();
 388
 389     /**
 390      * Remove duplicates in {@code List} of {@code UserAction} objects. We need to clean this up for user actions
 391      * that appear multiple times.
 392      * TODO: This static method is probably just for temporary and we could get rid of this after we clean up
 393      * TODO:    the pipeline
 394      *
 395      * @param listUserAction A {@link List} of {@code UserAction}.
 396      *
 397      */
 398     public static List<UserAction> removeDuplicates(List<UserAction> listUserAction) {
 399
 400         // Iterate and check for duplicates (check timestamps)
 401         Set<Long> epochSecondSet = new HashSet<>();
 402         // Create a target list for cleaned up list
 403         List<UserAction> listUserActionClean = new ArrayList<>();
 404         for(UserAction userAction : listUserAction) {
 405             // Don't insert if any duplicate is found
 406             if(!epochSecondSet.contains(userAction.getTimestamp().getEpochSecond())) {
 407                 listUserActionClean.add(userAction);
 408                 epochSecondSet.add(userAction.getTimestamp().getEpochSecond());
 409             }
 410         }
 411         return listUserActionClean;
 412     }
 413
 414     public SignatureDetector(List<List<List<PcapPacket>>> searchedSignature, String routerWanIp) {
 415         // note: doesn't protect inner lists from changes :'(
 416         mSignature = Collections.unmodifiableList(searchedSignature);
 417         // Generate corresponding/appropriate ClusterMatchers based on the provided signature
 418         List<ClusterMatcher> clusterMatchers = new ArrayList<>();
 419         for (List<List<PcapPacket>> cluster : mSignature) {
 420             clusterMatchers.add(new ClusterMatcher(cluster, routerWanIp, this));
 421         }
 422         mClusterMatchers = Collections.unmodifiableList(clusterMatchers);
 423
 424         // < exploratory >
 425         pendingMatches = new List[mClusterMatchers.size()];
 426         for (int i = 0; i < pendingMatches.length; i++) {
 427             pendingMatches[i] = new ArrayList<>();
 428         }
 429         Map<ClusterMatcher, Integer> clusterMatcherIds = new HashMap<>();
 430         for (int i = 0; i < mClusterMatchers.size(); i++) {
 431             clusterMatcherIds.put(mClusterMatchers.get(i), i);
 432         }
 433         mClusterMatcherIds = Collections.unmodifiableMap(clusterMatcherIds);
 434     }
 435
 436     public void addObserver(SignatureDetectionObserver observer) {
 437         mObservers.add(observer);
 438     }
 439
 440     public boolean removeObserver(SignatureDetectionObserver observer) {
 441         return mObservers.remove(observer);
 442     }
 443
 444     @Override
 445     public void gotPacket(PcapPacket packet) {
 446         // simply delegate packet reception to all ClusterMatchers.
 447         mClusterMatchers.forEach(cm -> cm.gotPacket(packet));
 448     }
 449
 450     @Override
 451     public void onMatch(ClusterMatcher clusterMatcher, List<PcapPacket> match) {
 452         // Add the match at the corresponding index
 453         pendingMatches[mClusterMatcherIds.get(clusterMatcher)].add(match);
 454         checkSignatureMatch();
 455     }
 456
 457     private void checkSignatureMatch() {
 458         // << Graph-based approach using Balint's idea. >>
 459         // This implementation assumes that the packets in the inner lists (the sequences) are ordered by asc timestamp.
 460
 461         // There cannot be a signature match until each ClusterMatcher has found a match of its respective sequence.
 462         if (Arrays.stream(pendingMatches).noneMatch(l -> l.isEmpty())) {
 463             // Construct the DAG
 464             final SimpleDirectedWeightedGraph<Vertex, DefaultWeightedEdge> graph =
 465                     new SimpleDirectedWeightedGraph<>(DefaultWeightedEdge.class);
 466             // Add a vertex for each match found by all ClusterMatchers
 467             // And maintain an array to keep track of what cluster matcher each vertex corresponds to
 468             final List<Vertex>[] vertices = new List[pendingMatches.length];
 469             for (int i = 0; i < pendingMatches.length; i++) {
 470                 vertices[i] = new ArrayList<>();
 471                 for (List<PcapPacket> sequence : pendingMatches[i]) {
 472                     Vertex v = new Vertex(sequence);
 473                     vertices[i].add(v); // retain reference for later when we are to add edges
 474                     graph.addVertex(v); // add to vertex to graph
 475                 }
 476             }
 477             // Add dummy source and sink vertices to facilitate search.
 478             final Vertex source = new Vertex(null);
 479             final Vertex sink = new Vertex(null);
 480             graph.addVertex(source);
 481             graph.addVertex(sink);
 482             // The source is connected to all vertices that wrap the sequences detected by ClusterMatcher at index 0.
 483             // Note: zero cost edges as this is just a dummy link to facilitate search from a common start node.
 484             for (Vertex v : vertices[0]) {
 485                 DefaultWeightedEdge edge = graph.addEdge(source, v);
 486                 graph.setEdgeWeight(edge, 0.0);
 487             }
 488             // Similarly, all vertices that wrap the sequences detected by the last ClusterMatcher of the signature
 489             // are connected to the sink node.
 490             for (Vertex v : vertices[vertices.length-1]) {
 491                 DefaultWeightedEdge edge = graph.addEdge(v, sink);
 492                 graph.setEdgeWeight(edge, 0.0);
 493             }
 494             // Now link sequences detected by ClusterMatcher at index i to sequences detected by ClusterMatcher at index
 495             // i+1 if they obey the timestamp constraint (i.e., that the latter is later in time than the former).
 496             for (int i = 0; i < vertices.length; i++) {
 497                 int j = i + 1;
 498                 if (j < vertices.length) {
 499                     for (Vertex iv : vertices[i]) {
 500                         PcapPacket ivLast = iv.sequence.get(iv.sequence.size()-1);
 501                         for (Vertex jv : vertices[j]) {
 502                             PcapPacket jvFirst = jv.sequence.get(jv.sequence.size()-1);
 503                             if (ivLast.getTimestamp().isBefore(jvFirst.getTimestamp())) {
 504                                 DefaultWeightedEdge edge = graph.addEdge(iv, jv);
 505                                 // The weight is the duration of the i'th sequence plus the duration between the i'th
 506                                 // and i+1'th sequence.
 507                                 Duration d = Duration.
 508                                         between(iv.sequence.get(0).getTimestamp(), jvFirst.getTimestamp());
 509                                 // Unfortunately weights are double values, so must convert from long to double.
 510                                 // TODO: need nano second precision? If so, use d.toNanos().
 511                                 // TODO: risk of overflow when converting from long to double..?
 512                                 graph.setEdgeWeight(edge, Long.valueOf(d.toMillis()).doubleValue());
 513                             }
 514                             // Alternative version if we cannot assume that sequences are ordered by timestamp:
 515 //                            if (iv.sequence.stream().max(Comparator.comparing(PcapPacket::getTimestamp)).get()
 516 //                                    .getTimestamp().isBefore(jv.sequence.stream().min(
 517 //                                            Comparator.comparing(PcapPacket::getTimestamp)).get().getTimestamp())) {
 518 //
 519 //                            }
 520                         }
 521                     }
 522                 }
 523             }
 524             // Graph construction complete, run shortest-path to find a (potential) signature match.
 525             DijkstraShortestPath<Vertex, DefaultWeightedEdge> dijkstra = new DijkstraShortestPath<>(graph);
 526             GraphPath<Vertex, DefaultWeightedEdge> shortestPath = dijkstra.getPath(source, sink);
 527             if (shortestPath != null) {
 528                 // The total weight is the duration between the first packet of the first sequence and the last packet
 529                 // of the last sequence, so we simply have to compare the weight against the timeframe that we allow
 530                 // the signature to span. For now we just use the inclusion window we defined for training purposes.
 531                 // Note however, that we must convert back from double to long as the weight is stored as a double in
 532                 // JGraphT's API.
 533                 if (((long)shortestPath.getWeight()) < TriggerTrafficExtractor.INCLUSION_WINDOW_MILLIS) {
 534                     // There's a signature match!
 535                     // Extract the match from the vertices
 536                     List<List<PcapPacket>> signatureMatch = new ArrayList<>();
 537                     for(Vertex v : shortestPath.getVertexList()) {
 538                         if (v == source || v == sink) {
 539                             // Skip the dummy source and sink nodes.
 540                             continue;
 541                         }
 542                         signatureMatch.add(v.sequence);
 543                         // As there is a one-to-one correspondence between vertices[] and pendingMatches[], we know that
 544                         // the sequence we've "consumed" for index i of the matched signature is also at index i in
 545                         // pendingMatches. We must remove it from pendingMatches so that we don't use it to construct
 546                         // another signature match in a later call.
 547                         pendingMatches[signatureMatch.size()-1].remove(v.sequence);
 548                     }
 549                     // Declare success: notify observers
 550                     mObservers.forEach(obs -> obs.onSignatureDetected(mSignature,
 551                             Collections.unmodifiableList(signatureMatch)));
 552                 }
 553             }
 554         }
 555     }
 556
 557     /**
 558      * Used for registering for notifications of signatures detected by a {@link SignatureDetector}.
 559      */
 560     interface SignatureDetectionObserver {
 561
 562         /**
 563          * Invoked when the {@link SignatureDetector} detects the presence of a signature in the traffic that it's
 564          * examining.
 565          * @param searchedSignature The signature that the {@link SignatureDetector} reporting the match is searching
 566          *                          for.
 567          * @param matchingTraffic The actual traffic trace that matches the searched signature.
 568          */
 569         void onSignatureDetected(List<List<List<PcapPacket>>> searchedSignature,
 570                                  List<List<PcapPacket>> matchingTraffic);
 571     }
 572
 573     /**
 574      * Encapsulates a {@code List<PcapPacket>} so as to allow the list to be used as a vertex in a graph while avoiding
 575      * the expensive {@link AbstractList#equals(Object)} calls when adding vertices to the graph.
 576      * Using this wrapper makes the incurred {@code equals(Object)} calls delegate to {@link Object#equals(Object)}
 577      * instead of {@link AbstractList#equals(Object)}. The net effect is a faster implementation, but the graph will not
 578      * recognize two lists that contain the same items--from a value and not reference point of view--as the same
 579      * vertex. However, this is fine for our purposes -- in fact restricting it to reference equality seems more
 580      * appropriate.
 581      */
 582     private static class Vertex {
 583         private final List<PcapPacket> sequence;
 584         private Vertex(List<PcapPacket> wrappedSequence) {
 585             sequence = wrappedSequence;
 586         }
 587     }
 588 }