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

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