1 package edu.uci.iotproject;
3 import static edu.uci.iotproject.analysis.UserAction.Type;
5 import edu.uci.iotproject.analysis.TcpConversationUtils;
6 import edu.uci.iotproject.analysis.TrafficLabeler;
7 import edu.uci.iotproject.analysis.TriggerTrafficExtractor;
8 import edu.uci.iotproject.analysis.UserAction;
9 import edu.uci.iotproject.comparison.seqalignment.ExtractedSequence;
10 import edu.uci.iotproject.comparison.seqalignment.SequenceAlignment;
11 import edu.uci.iotproject.comparison.seqalignment.SequenceExtraction;
12 import edu.uci.iotproject.io.TriggerTimesFileReader;
13 import org.pcap4j.core.*;
14 import org.pcap4j.packet.namednumber.DataLinkType;
16 import java.io.EOFException;
18 import java.io.PrintWriter;
19 import java.net.UnknownHostException;
20 import java.time.Instant;
22 import java.util.concurrent.TimeoutException;
25 * This is a system that reads PCAP files to compare
26 * patterns of DNS hostnames, packet sequences, and packet
27 * lengths with training data to determine certain events
28 * or actions for smart home devices.
30 * @author Janus Varmarken
31 * @author Rahmadi Trimananda (rtrimana@uci.edu)
37 public static void main(String[] args) throws PcapNativeException, NotOpenException, EOFException, TimeoutException, UnknownHostException {
38 // -------------------------------------------------------------------------------------------------------------
39 // ------------ # Code for extracting traffic generated by a device within x seconds of a trigger # ------------
40 // Paths to input and output files (consider supplying these as arguments instead) and IP of the device for
41 // which traffic is to be extracted:
42 String path = "/scratch/July-2018"; // Rahmadi
43 // String path = "/Users/varmarken/temp/UCI IoT Project/experiments"; // Janus
44 boolean verbose = false;
45 final String onPairsPath = "/scratch/July-2018/on.txt";
46 final String offPairsPath = "/scratch/July-2018/off.txt";
48 // 1) D-Link July 26 experiment
49 // final String inputPcapFile = path + "/2018-07/dlink/dlink.wlan1.local.pcap";
50 // final String outputPcapFile = path + "/2018-07/dlink/dlink-processed.pcap";
51 // final String triggerTimesFile = path + "/2018-07/dlink/dlink-july-26-2018.timestamps";
52 // final String deviceIp = "192.168.1.246"; // .246 == phone; .199 == dlink plug?
54 // 2) TP-Link July 25 experiment
55 final String inputPcapFile = path + "/2018-07/tplink/tplink.wlan1.local.pcap";
56 final String outputPcapFile = path + "/2018-07/tplink/tplink-processed.pcap";
57 final String triggerTimesFile = path + "/2018-07/tplink/tplink-july-25-2018.timestamps";
58 final String deviceIp = "192.168.1.159";
60 // 2b) TP-Link July 25 experiment TRUNCATED:
61 // Only contains "true local" events, i.e., before the behavior changes to remote-like behavior.
62 // Last included event is at July 25 10:38:11; file filtered to only include packets with arrival time <= 10:38:27.
63 // final String inputPcapFile = path + "/2018-07/tplink/tplink.wlan1.local.truncated.pcap";
64 // final String outputPcapFile = path + "/2018-07/tplink/tplink-processed.truncated.pcap";
65 // final String triggerTimesFile = path + "/2018-07/tplink/tplink-july-25-2018.truncated.timestamps";
66 // final String deviceIp = "192.168.1.159";
68 // 3) SmartThings Plug July 25 experiment
69 // final String inputPcapFile = path + "/2018-07/stplug/stplug.wlan1.local.pcap";
70 // final String outputPcapFile = path + "/2018-07/stplug/stplug-processed.pcap";
71 // final String triggerTimesFile = path + "/2018-07/stplug/smartthings-july-25-2018.timestamps";
72 // final String deviceIp = "192.168.1.246"; // .246 == phone; .142 == SmartThings Hub (note: use eth0 capture for this!)
74 // 4) Wemo July 30 experiment
75 // final String inputPcapFile = path + "/2018-07/wemo/wemo.wlan1.local.pcap";
76 // final String outputPcapFile = path + "/2018-07/wemo/wemo-processed.pcap";
77 // final String triggerTimesFile = path + "/2018-07/wemo/wemo-july-30-2018.timestamps";
78 // final String deviceIp = "192.168.1.145";
80 // 5) Wemo Insight July 31 experiment
81 // final String inputPcapFile = path + "/2018-07/wemoinsight/wemoinsight.wlan1.local.pcap";
82 // final String outputPcapFile = path + "/2018-07/wemoinsight/wemoinsight-processed.pcap";
83 // final String triggerTimesFile = path + "/2018-07/wemoinsight/wemo-insight-july-31-2018.timestamps";
84 // final String deviceIp = "192.168.1.135";
86 // 6) TP-Link Bulb August 1 experiment
87 // final String inputPcapFile = path + "/2018-08/tplink-bulb/tplinkbulb.wlan1.local.pcap";
88 // final String outputPcapFile = path + "/2018-08/tplink-bulb/tplinkbulb-processed.pcap";
89 // final String triggerTimesFile = path + "/2018-08/tplink-bulb/tplink-bulb-aug-3-2018.timestamps";
90 // final String deviceIp = "192.168.1.246";
92 // 7) Kwikset Doorlock August 6 experiment
93 // final String inputPcapFile = path + "/2018-08/kwikset-doorlock/kwikset-doorlock.wlan1.local.pcap";
94 // final String outputPcapFile = path + "/2018-08/kwikset-doorlock/kwikset-doorlock-processed.pcap";
95 // final String triggerTimesFile = path + "/2018-08/kwikset-doorlock/kwikset-doorlock-aug-6-2018.timestamps";
96 // final String deviceIp = "192.168.1.246"; // .246 == phone; .142 == SmartThings Hub (note: use eth0 capture for this!)
98 // 8) Hue Bulb August 7 experiment
99 // final String inputPcapFile = path + "/2018-08/hue-bulb/hue-bulb.wlan1.local.pcap";
100 // final String outputPcapFile = path + "/2018-08/hue-bulb/hue-bulb-processed.pcap";
101 // final String triggerTimesFile = path + "/2018-08/hue-bulb/hue-bulb-aug-7-2018.timestamps";
102 // final String deviceIp = "192.168.1.246";
104 // 9) Lifx Bulb August 8 experiment
105 // final String inputPcapFile = path + "/2018-08/lifx-bulb/lifx-bulb.wlan1.local.pcap";
106 // final String outputPcapFile = path + "/2018-08/lifx-bulb/lifx-bulb-processed.pcap";
107 // final String triggerTimesFile = path + "/2018-08/lifx-bulb/lifx-bulb-aug-8-2018.timestamps";
108 // final String deviceIp = "192.168.1.231"; // .246 == phone; .231 == Lifx
110 // 10) Amcrest Camera August 9 experiment
111 // final String inputPcapFile = path + "/2018-08/amcrest-camera/amcrest-camera.wlan1.local.pcap";
112 // final String outputPcapFile = path + "/2018-08/amcrest-camera/amcrest-camera-processed.pcap";
113 // final String triggerTimesFile = path + "/2018-08/amcrest-camera/amcrest-camera-aug-9-2018.timestamps";
114 // final String deviceIp = "192.168.1.246"; // .246 == phone; .235 == camera
116 // 11) Arlo Camera August 10 experiment
117 // final String inputPcapFile = path + "/2018-08/arlo-camera/arlo-camera.wlan1.local.pcap";
118 // final String outputPcapFile = path + "/2018-08/arlo-camera/arlo-camera-processed.pcap";
119 // final String triggerTimesFile = path + "/2018-08/arlo-camera/arlo-camera-aug-10-2018.timestamps";
120 // final String deviceIp = "192.168.1.140"; // .246 == phone; .140 == camera
122 // 12) Blossom sprinkler August 13 experiment
123 // final String inputPcapFile = path + "/2018-08/blossom/blossom.wlan1.local.pcap";
124 // final String outputPcapFile = path + "/2018-08/blossom/blossom-processed.pcap";
125 // final String triggerTimesFile = path + "/2018-08/blossom/blossom-aug-13-2018.timestamps";
126 // final String deviceIp = "192.168.1.246"; // .246 == phone; .229 == sprinkler
128 // 13) DLink siren August 14 experiment
129 // final String inputPcapFile = path + "/2018-08/dlink-siren/dlink-siren.wlan1.local.pcap";
130 // final String outputPcapFile = path + "/2018-08/dlink-siren/dlink-siren-processed.pcap";
131 // final String triggerTimesFile = path + "/2018-08/dlink-siren/dlink-siren-aug-14-2018.timestamps";
132 // final String deviceIp = "192.168.1.246"; // .246 == phone; .183 == siren
134 // 14) Nest thermostat August 15 experiment
135 // final String inputPcapFile = path + "/2018-08/nest/nest.wlan1.local.pcap";
136 // final String outputPcapFile = path + "/2018-08/nest/nest-processed.pcap";
137 // final String triggerTimesFile = path + "/2018-08/nest/nest-aug-15-2018.timestamps";
138 // final String deviceIp = "192.168.1.246"; // .246 == phone; .127 == Nest thermostat
140 // 15) Alexa August 16 experiment
141 // final String inputPcapFile = path + "/2018-08/alexa/alexa.wlan1.local.pcap";
142 // final String outputPcapFile = path + "/2018-08/alexa/alexa-processed.pcap";
143 // final String triggerTimesFile = path + "/2018-08/alexa/alexa-aug-16-2018.timestamps";
144 // final String deviceIp = "192.168.1.225"; // .246 == phone; .225 == Alexa
146 // final String inputPcapFile = path + "/2018-08/alexa/alexa2.wlan1.local.pcap";
147 // final String outputPcapFile = path + "/2018-08/alexa/alexa2-processed.pcap";
148 // final String triggerTimesFile = path + "/2018-08/alexa/alexa-aug-17-2018.timestamps";
149 // final String deviceIp = "192.168.1.225"; // .246 == phone; .225 == Alexa
151 TriggerTimesFileReader ttfr = new TriggerTimesFileReader();
152 List<Instant> triggerTimes = ttfr.readTriggerTimes(triggerTimesFile, false);
153 // Tag each trigger with "ON" or "OFF", assuming that the first trigger is an "ON" and that they alternate.
154 List<UserAction> userActions = new ArrayList<>();
155 for (int i = 0; i < triggerTimes.size(); i++) {
156 userActions.add(new UserAction(i % 2 == 0 ? Type.TOGGLE_ON : Type.TOGGLE_OFF, triggerTimes.get(i)));
158 TriggerTrafficExtractor tte = new TriggerTrafficExtractor(inputPcapFile, triggerTimes, deviceIp);
159 final PcapDumper outputter = Pcaps.openDead(DataLinkType.EN10MB, 65536).dumpOpen(outputPcapFile);
160 DnsMap dnsMap = new DnsMap();
161 TcpReassembler tcpReassembler = new TcpReassembler();
162 TrafficLabeler trafficLabeler = new TrafficLabeler(userActions);
163 tte.performExtraction(pkt -> {
166 } catch (NotOpenException e) {
169 }, dnsMap, tcpReassembler, trafficLabeler);
173 if (tte.getPacketsIncludedCount() != trafficLabeler.getTotalPacketCount()) {
174 // Sanity/debug check
175 throw new AssertionError(String.format("mismatch between packet count in %s and %s",
176 TriggerTrafficExtractor.class.getSimpleName(), TrafficLabeler.class.getSimpleName()));
179 // Extract all conversations present in the filtered trace.
180 List<Conversation> allConversations = tcpReassembler.getTcpConversations();
181 // Group conversations by hostname.
182 Map<String, List<Conversation>> convsByHostname = TcpConversationUtils.groupConversationsByHostname(allConversations, dnsMap);
183 System.out.println("Grouped conversations by hostname.");
184 // For each hostname, count the frequencies of packet lengths exchanged with that hostname.
185 final Map<String, Map<Integer, Integer>> pktLenFreqsByHostname = new HashMap<>();
186 convsByHostname.forEach((host, convs) -> pktLenFreqsByHostname.put(host, TcpConversationUtils.countPacketLengthFrequencies(convs)));
187 System.out.println("Counted frequencies of packet lengths exchanged with each hostname.");
188 // For each hostname, count the frequencies of packet sequences (i.e., count how many conversations exchange a
189 // sequence of packets of some specific lengths).
190 final Map<String, Map<String, Integer>> pktSeqFreqsByHostname = new HashMap<>();
191 convsByHostname.forEach((host, convs) -> pktSeqFreqsByHostname.put(host, TcpConversationUtils.countPacketSequenceFrequencies(convs)));
192 System.out.println("Counted frequencies of packet sequences exchanged with each hostname.");
193 // For each hostname, count frequencies of packet pairs exchanged with that hostname across all conversations
194 final Map<String, Map<String, Integer>> pktPairFreqsByHostname =
195 TcpConversationUtils.countPacketPairFrequenciesByHostname(allConversations, dnsMap);
196 System.out.println("Counted frequencies of packet pairs per hostname");
197 // For each user action, reassemble the set of TCP connections occurring shortly after
198 final Map<UserAction, List<Conversation>> userActionToConversations = trafficLabeler.getLabeledReassembledTcpTraffic();
199 final Map<UserAction, Map<String, List<Conversation>>> userActionsToConvsByHostname = trafficLabeler.getLabeledReassembledTcpTraffic(dnsMap);
200 System.out.println("Reassembled TCP conversations occurring shortly after each user event");
204 // Contains all ON events: hostname -> sequence identifier -> list of conversations with that sequence
205 Map<String, Map<String, List<Conversation>>> ons = new HashMap<>();
206 // Contains all OFF events: hostname -> sequence identifier -> list of conversations with that sequence
207 Map<String, Map<String, List<Conversation>>> offs = new HashMap<>();
210 userActionsToConvsByHostname.forEach((ua, hostnameToConvs) -> {
211 Map<String, Map<String, List<Conversation>>> outer = ua.getType() == Type.TOGGLE_ON ? ons : offs;
212 hostnameToConvs.forEach((host, convs) -> {
213 Map<String, List<Conversation>> seqsToConvs = TcpConversationUtils.
214 groupConversationsByPacketSequenceVerbose(convs);
215 outer.merge(host, seqsToConvs, (oldMap, newMap) -> {
216 newMap.forEach((sequence, cs) -> oldMap.merge(sequence, cs, (list1, list2) -> {
225 userActionsToConvsByHostname.forEach((ua, hostnameToConvs) -> {
226 Map<String, Map<String, List<Conversation>>> outer = ua.getType() == Type.TOGGLE_ON ? ons : offs;
227 hostnameToConvs.forEach((host, convs) -> {
228 Map<String, List<Conversation>> seqsToConvs = TcpConversationUtils.
229 groupConversationsByPacketSequence(convs);
230 outer.merge(host, seqsToConvs, (oldMap, newMap) -> {
231 newMap.forEach((sequence, cs) -> oldMap.merge(sequence, cs, (list1, list2) -> {
242 // Print out all the pairs into a file for ON events
243 File fileOnEvents = new File(onPairsPath);
244 PrintWriter pwOn = null;
246 pwOn = new PrintWriter(fileOnEvents);
247 } catch(Exception ex) {
248 ex.printStackTrace();
250 for(Map.Entry<String, Map<String, List<Conversation>>> entry : ons.entrySet()) {
251 Map<String, List<Conversation>> seqsToConvs = entry.getValue();
252 for(Map.Entry<String, List<Conversation>> entryConv : seqsToConvs.entrySet()) {
253 List<Conversation> listConv = entryConv.getValue();
254 // Just get the first Conversation because all Conversations in this group
255 // should have the same pairs of Application Data.
256 for(Conversation conv : listConv) {
257 // Process only if it is a TLS packet
259 List<PcapPacket> tlsAppDataList = conv.getTlsApplicationDataPackets();
260 // Loop and print out packets
262 // The direction of the first packet
263 Conversation.Direction firstDir = null;
264 // The length of the first packet
266 for (PcapPacket pcap : tlsAppDataList) {
267 boolean isPair = false;
268 if (count % 2 == 0) {
269 firstDir = conv.getDirection(pcap);
270 firstLen = pcap.length();
271 } else {// count%2 == 1
272 if(conv.getDirection(pcap) != firstDir) {
274 pwOn.println(firstLen + ", " + pcap.length());
275 //System.out.println(firstDir + ", " + conv.getDirection(pcap));
276 //System.out.println(firstLen + ", " + pcap.length());
280 // If we can't create a pair then just pad it with 0
281 if (count == tlsAppDataList.size() && !isPair) {
282 pwOn.println(firstLen + ", 0");
285 } else { // Non-TLS conversations
286 List<PcapPacket> packetList = conv.getPackets();
287 // Loop and print out packets
289 // The direction of the first packet
290 Conversation.Direction firstDir = null;
291 // The length of the first packet
293 for (PcapPacket pcap : packetList) {
294 System.out.println(pcap.length() + ", " + conv.getDirection(pcap));
295 boolean isPair = false;
296 if (count % 2 == 0) {
297 firstDir = conv.getDirection(pcap);
298 firstLen = pcap.length();
299 } else {// count%2 == 1
300 if(conv.getDirection(pcap) != firstDir) {
302 pwOn.println(firstLen + ", " + pcap.length());
303 //System.out.println(firstDir + ", " + conv.getDirection(pcap));
304 //System.out.println(firstLen + ", " + pcap.length());
308 // If we can't create a pair then just pad it with 0
309 if (count == packetList.size() && !isPair) {
310 pwOn.println(firstLen + ", 0");
319 // Print out all the pairs into a file for ON events
320 File fileOffEvents = new File(offPairsPath);
321 PrintWriter pwOff = null;
323 pwOff = new PrintWriter(fileOffEvents);
324 } catch(Exception ex) {
325 ex.printStackTrace();
327 for(Map.Entry<String, Map<String, List<Conversation>>> entry : offs.entrySet()) {
328 Map<String, List<Conversation>> seqsToConvs = entry.getValue();
329 for(Map.Entry<String, List<Conversation>> entryConv : seqsToConvs.entrySet()) {
330 List<Conversation> listConv = entryConv.getValue();
331 // Just get the first Conversation because all Conversations in this group
332 // should have the same pairs of Application Data.
333 for(Conversation conv : listConv) {
334 // Process only if it is a TLS packet
336 List<PcapPacket> tlsAppDataList = conv.getTlsApplicationDataPackets();
337 // Loop and print out packets
339 // The direction of the first packet
340 Conversation.Direction firstDir = null;
341 // The length of the first packet
343 for (PcapPacket pcap : tlsAppDataList) {
344 boolean isPair = false;
345 if (count % 2 == 0) {
346 firstDir = conv.getDirection(pcap);
347 firstLen = pcap.length();
348 } else {// count%2 == 1
349 if(conv.getDirection(pcap) != firstDir) {
351 pwOff.println(firstLen + ", " + pcap.length());
352 System.out.println(firstDir + ", " + conv.getDirection(pcap));
353 System.out.println(firstLen + ", " + pcap.length());
357 // If we can't create a pair then just pad it with 0
358 if (count == tlsAppDataList.size() && !isPair) {
359 pwOff.println(firstLen + ", 0");
363 } else { // Non-TLS conversations
364 List<PcapPacket> packetList = conv.getPackets();
365 // Loop and print out packets
367 // The direction of the first packet
368 Conversation.Direction firstDir = null;
369 // The length of the first packet
371 for (PcapPacket pcap : packetList) {
372 System.out.println(pcap.length() + ", " + conv.getDirection(pcap));
373 boolean isPair = false;
374 if (count % 2 == 0) {
375 firstDir = conv.getDirection(pcap);
376 firstLen = pcap.length();
377 } else {// count%2 == 1
378 if(conv.getDirection(pcap) != firstDir) {
380 pwOff.println(firstLen + ", " + pcap.length());
381 System.out.println(firstDir + ", " + conv.getDirection(pcap));
382 System.out.println(firstLen + ", " + pcap.length());
386 // If we can't create a pair then just pad it with 0
387 if (count == packetList.size() && !isPair) {
388 pwOff.println(firstLen + ", 0");
398 // ================================================================================================
399 // <<< Some work-in-progress/explorative code that extracts a "representative" sequence >>>
401 // Currently need to know relevant hostname in advance :(
402 // String hostname = "events.tplinkra.com";
403 // String hostname = "rfe-us-west-1.dch.dlink.com";
404 // // Conversations with 'hostname' for ON events.
405 // List<Conversation> onsForHostname = new ArrayList<>();
406 // // Conversations with 'hostname' for OFF events.
407 // List<Conversation> offsForHostname = new ArrayList<>();
408 // // "Unwrap" sequence groupings in ons/offs maps.
409 // ons.get(hostname).forEach((k,v) -> onsForHostname.addAll(v));
410 // offs.get(hostname).forEach((k,v) -> offsForHostname.addAll(v));
413 // Map<String, List<Conversation>> onsForHostnameGroupedByTlsAppDataSequence = TcpConversationUtils.groupConversationsByTlsApplicationDataPacketSequence(onsForHostname);
416 // // Extract representative sequence for ON and OFF by providing the list of conversations with
417 // // 'hostname' observed for each event type (the training data).
418 // SequenceExtraction seqExtraction = new SequenceExtraction();
419 //// ExtractedSequence extractedSequenceForOn = seqExtraction.extract(onsForHostname);
420 //// ExtractedSequence extractedSequenceForOff = seqExtraction.extract(offsForHostname);
422 // ExtractedSequence extractedSequenceForOn = seqExtraction.extractByTlsAppData(onsForHostname);
423 // ExtractedSequence extractedSequenceForOff = seqExtraction.extractByTlsAppData(offsForHostname);
425 // // Let's check how many ONs align with OFFs and vice versa (that is, how many times an event is incorrectly
427 // int onsLabeledAsOff = 0;
428 // Integer[] representativeOnSeq = TcpConversationUtils.getPacketLengthSequence(extractedSequenceForOn.getRepresentativeSequence());
429 // Integer[] representativeOffSeq = TcpConversationUtils.getPacketLengthSequence(extractedSequenceForOff.getRepresentativeSequence());
430 // SequenceAlignment<Integer> seqAlg = seqExtraction.getAlignmentAlgorithm();
431 // for (Conversation c : onsForHostname) {
432 // Integer[] onSeq = TcpConversationUtils.getPacketLengthSequence(c);
433 // if (seqAlg.calculateAlignment(representativeOffSeq, onSeq) <= extractedSequenceForOff.getMaxAlignmentCost()) {
434 // onsLabeledAsOff++;
437 // int offsLabeledAsOn = 0;
438 // for (Conversation c : offsForHostname) {
439 // Integer[] offSeq = TcpConversationUtils.getPacketLengthSequence(c);
440 // if (seqAlg.calculateAlignment(representativeOnSeq, offSeq) <= extractedSequenceForOn.getMaxAlignmentCost()) {
441 // offsLabeledAsOn++;
444 // System.out.println("");
445 // ================================================================================================
448 // -------------------------------------------------------------------------------------------------------------
449 // -------------------------------------------------------------------------------------------------------------
455 // TP-Link MAC 50:c7:bf:33:1f:09 and usually IP 192.168.1.159 (remember to verify per file)
456 // frame.len >= 556 && frame.len <= 558 && ip.addr == 192.168.1.159