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

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