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