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