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