MembersMgmtCommAttack.py 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654
  1. from enum import Enum
  2. from random import randint, randrange, choice, uniform
  3. from collections import deque
  4. from scipy.stats import gamma
  5. from lea import Lea
  6. from datetime import datetime
  7. import os
  8. import sys
  9. import ID2TLib.libbotnetcomm as lb
  10. from Attack import BaseAttack
  11. from Attack.AttackParameters import Parameter as Param
  12. from Attack.AttackParameters import ParameterTypes
  13. from ID2TLib.Ports import PortSelectors
  14. class MessageType(Enum):
  15. """
  16. Defines possible botnet message types
  17. """
  18. TIMEOUT = 3
  19. SALITY_NL_REQUEST = 101
  20. SALITY_NL_REPLY = 102
  21. SALITY_HELLO = 103
  22. SALITY_HELLO_REPLY = 104
  23. def is_request(mtype):
  24. return mtype in {MessageType.SALITY_HELLO, MessageType.SALITY_NL_REQUEST}
  25. def is_response(mtype):
  26. return mtype in {MessageType.SALITY_HELLO_REPLY, MessageType.SALITY_NL_REPLY}
  27. class Message():
  28. INVALID_LINENO = -1
  29. """
  30. Defines a compact message type that contains all necessary information.
  31. """
  32. def __init__(self, msg_id: int, src, dst, type_: MessageType, time: float, refer_msg_id: int=-1, line_no = -1):
  33. """
  34. Constructs a message with the given parameters.
  35. :param msg_id: the ID of the message
  36. :param src: something identifiying the source, e.g. ID or configuration
  37. :param dst: something identifiying the destination, e.g. ID or configuration
  38. :param type_: the type of the message
  39. :param time: the timestamp of the message
  40. :param refer_msg_id: the ID this message is a request for or reply to. -1 if there is no related message.
  41. :param line_no: The line number this message appeared in the original file
  42. """
  43. self.msg_id = msg_id
  44. self.src = src
  45. self.dst = dst
  46. self.type = type_
  47. self.time = time
  48. self.refer_msg_id = refer_msg_id
  49. # if similar fields to line_no should be added consider a separate class
  50. self.line_no = line_no
  51. def __str__(self):
  52. str_ = "{0}. at {1}: {2}-->{3}, {4}, refer:{5}".format(self.msg_id, self.time, self.src, self.dst, self.type, self.refer_msg_id)
  53. return str_
  54. from ID2TLib import FileUtils, Generator
  55. from ID2TLib.IPv4 import IPAddress
  56. from ID2TLib.PcapAddressOperations import PcapAddressOperations
  57. from ID2TLib.CommunicationProcessor import CommunicationProcessor
  58. from ID2TLib.Botnet.MessageMapping import MessageMapping
  59. from ID2TLib.PcapFile import PcapFile
  60. from ID2TLib.Statistics import Statistics
  61. class MembersMgmtCommAttack(BaseAttack.BaseAttack):
  62. def __init__(self):
  63. """
  64. Creates a new instance of the Membership Management Communication.
  65. """
  66. # Initialize communication
  67. super(MembersMgmtCommAttack, self).__init__("Membership Management Communication Attack (MembersMgmtCommAttack)",
  68. "Injects Membership Management Communication", "Botnet communication")
  69. # Define allowed parameters and their type
  70. self.supported_params = {
  71. # parameters regarding attack
  72. Param.INJECT_AT_TIMESTAMP: ParameterTypes.TYPE_FLOAT,
  73. Param.INJECT_AFTER_PACKET: ParameterTypes.TYPE_PACKET_POSITION,
  74. Param.PACKETS_PER_SECOND: ParameterTypes.TYPE_FLOAT,
  75. Param.PACKETS_LIMIT: ParameterTypes.TYPE_INTEGER_POSITIVE,
  76. Param.ATTACK_DURATION: ParameterTypes.TYPE_INTEGER_POSITIVE,
  77. # use num_attackers to specify number of communicating devices?
  78. Param.NUMBER_INITIATOR_BOTS: ParameterTypes.TYPE_INTEGER_POSITIVE,
  79. # input file containing botnet communication
  80. Param.FILE_CSV: ParameterTypes.TYPE_FILEPATH,
  81. Param.FILE_XML: ParameterTypes.TYPE_FILEPATH,
  82. # the percentage of IP reuse (if total and other is specified, percentages are multiplied)
  83. Param.IP_REUSE_TOTAL: ParameterTypes.TYPE_PERCENTAGE,
  84. Param.IP_REUSE_LOCAL: ParameterTypes.TYPE_PERCENTAGE,
  85. Param.IP_REUSE_EXTERNAL: ParameterTypes.TYPE_PERCENTAGE,
  86. # the user-selected padding to add to every packet
  87. Param.PACKET_PADDING: ParameterTypes.TYPE_PADDING,
  88. # presence of NAT at the gateway of the network
  89. Param.NAT_PRESENT: ParameterTypes.TYPE_BOOLEAN,
  90. # whether the TTL distribution should be based on the input PCAP
  91. # or the CAIDA dataset
  92. Param.TTL_FROM_CAIDA: ParameterTypes.TYPE_BOOLEAN,
  93. # whether the destination port of a response should be the ephemeral port
  94. # its request came from or a static (server)port based on a hostname
  95. Param.BOTNET_DST_PORT_CALCULATION: ParameterTypes.TYPE_BOOLEAN,
  96. # information about the interval selection strategy
  97. Param.INTERVAL_SELECT_STRATEGY: ParameterTypes.TYPE_INTERVAL_SELECT_STRAT,
  98. Param.INTERVAL_SELECT_START: ParameterTypes.TYPE_INTEGER_POSITIVE,
  99. Param.INTERVAL_SELECT_END: ParameterTypes.TYPE_INTEGER_POSITIVE
  100. }
  101. # create dict with MessageType values for fast name lookup
  102. self.msg_types = {}
  103. for msg_type in MessageType:
  104. self.msg_types[msg_type.value] = msg_type
  105. def init_params(self):
  106. """
  107. Initialize some parameters of this communication-attack using the user supplied command line parameters.
  108. The remaining parameters are implicitly set in the provided data file. Note: the timestamps in the file
  109. have to be sorted in ascending order
  110. :param statistics: Reference to a statistics object.
  111. """
  112. # set class constants
  113. self.DEFAULT_XML_PATH = "resources/MembersMgmtComm_example.xml"
  114. # probability for responder ID to be local if comm_type is mixed
  115. self.PROB_RESPND_IS_LOCAL = 0
  116. # PARAMETERS: initialize with default values
  117. # (values are overwritten if user specifies them)
  118. self.add_param_value(Param.INJECT_AFTER_PACKET, 1 + randint(0, self.statistics.get_packet_count() // 5))
  119. self.add_param_value(Param.PACKETS_PER_SECOND, 0)
  120. self.add_param_value(Param.FILE_XML, self.DEFAULT_XML_PATH)
  121. # Alternatively new attack parameter?
  122. duration = int(float(self._get_capture_duration()))
  123. self.add_param_value(Param.ATTACK_DURATION, duration)
  124. self.add_param_value(Param.NUMBER_INITIATOR_BOTS, 1)
  125. # NAT on by default
  126. self.add_param_value(Param.NAT_PRESENT, True)
  127. # TODO: change 1 to something better
  128. self.add_param_value(Param.IP_REUSE_TOTAL, 1)
  129. self.add_param_value(Param.IP_REUSE_LOCAL, 0.5)
  130. self.add_param_value(Param.IP_REUSE_EXTERNAL, 0.5)
  131. # add default additional padding
  132. self.add_param_value(Param.PACKET_PADDING, 20)
  133. # choose the input PCAP as default base for the TTL distribution
  134. self.add_param_value(Param.TTL_FROM_CAIDA, False)
  135. self.add_param_value(Param.BOTNET_DST_PORT_CALCULATION, True)
  136. # interval selection strategy
  137. self.add_param_value(Param.INTERVAL_SELECT_STRATEGY, "optimal")
  138. def generate_attack_pcap(self, context):
  139. """
  140. Injects the packets of this attack into a PCAP and stores it as a temporary file.
  141. :param context: the context of the attack, containing e.g. files that are to be created
  142. :return: a tuple of the number packets injected and the path to the temporary attack PCAP
  143. """
  144. # create the final messages that have to be sent, including all bot configurations
  145. messages = self._create_messages(context)
  146. if messages == []:
  147. return 0, []
  148. # Setup (initial) parameters for packet creation loop
  149. BUFFER_SIZE = 1000
  150. pkt_gen = Generator.PacketGenerator()
  151. padding = self.get_param_value(Param.PACKET_PADDING)
  152. packets = deque(maxlen=BUFFER_SIZE)
  153. total_pkts = 0
  154. limit_packetcount = self.get_param_value(Param.PACKETS_LIMIT)
  155. limit_duration = self.get_param_value(Param.ATTACK_DURATION)
  156. path_attack_pcap = None
  157. overThousand = False
  158. msg_packet_mapping = MessageMapping(messages)
  159. # create packets to write to PCAP file
  160. for msg in messages:
  161. # retrieve the source and destination configurations
  162. id_src, id_dst = msg.src["ID"], msg.dst["ID"]
  163. ip_src, ip_dst = msg.src["IP"], msg.dst["IP"]
  164. mac_src, mac_dst = msg.src["MAC"], msg.dst["MAC"]
  165. if msg.type.is_request():
  166. port_src, port_dst = int(msg.src["SrcPort"]), int(msg.dst["DstPort"])
  167. else:
  168. port_src, port_dst = int(msg.src["DstPort"]), int(msg.dst["SrcPort"])
  169. ttl = int(msg.src["TTL"])
  170. # update duration
  171. duration = msg.time - messages[0].time
  172. # if total number of packets has been sent or the attack duration has been exceeded, stop
  173. if ((limit_packetcount is not None and total_pkts >= limit_packetcount) or
  174. (limit_duration is not None and duration >= limit_duration)):
  175. break
  176. # if the type of the message is a NL reply, determine the number of entries
  177. nl_size = 0
  178. if msg.type == MessageType.SALITY_NL_REPLY:
  179. nl_size = randint(1, 25) # what is max NL entries?
  180. # create suitable IP/UDP packet and add to packets list
  181. packet = pkt_gen.generate_mmcom_packet(ip_src=ip_src, ip_dst=ip_dst, ttl=ttl, mac_src=mac_src, mac_dst=mac_dst,
  182. port_src=port_src, port_dst=port_dst, message_type=msg.type, neighborlist_entries=nl_size)
  183. Generator.add_padding(packet, padding,True, True)
  184. packet.time = msg.time
  185. packets.append(packet)
  186. msg_packet_mapping.map_message(msg, packet)
  187. total_pkts += 1
  188. # Store timestamp of first packet (for attack label)
  189. if total_pkts <= 1:
  190. self.attack_start_utime = packets[0].time
  191. elif total_pkts % BUFFER_SIZE == 0: # every 1000 packets write them to the PCAP file (append)
  192. if overThousand: # if over 1000 packets written, there may be a different packet-length for the last few packets
  193. packets = list(packets)
  194. Generator.equal_length(packets, length = max_len, padding = padding, force_len = True)
  195. last_packet = packets[-1]
  196. path_attack_pcap = self.write_attack_pcap(packets, True, path_attack_pcap)
  197. packets = deque(maxlen=BUFFER_SIZE)
  198. else:
  199. packets = list(packets)
  200. Generator.equal_length(packets, padding = padding)
  201. last_packet = packets[-1]
  202. max_len = len(last_packet)
  203. overThousand = True
  204. path_attack_pcap = self.write_attack_pcap(packets, True, path_attack_pcap)
  205. packets = deque(maxlen=BUFFER_SIZE)
  206. # if there are unwritten packets remaining, write them to the PCAP file
  207. if len(packets) > 0:
  208. if overThousand:
  209. packets = list(packets)
  210. Generator.equal_length(packets, length = max_len, padding = padding, force_len = True)
  211. path_attack_pcap = self.write_attack_pcap(packets, True, path_attack_pcap)
  212. last_packet = packets[-1]
  213. else:
  214. packets = list(packets)
  215. Generator.equal_length(packets, padding = padding)
  216. path_attack_pcap = self.write_attack_pcap(packets, True, path_attack_pcap)
  217. last_packet = packets[-1]
  218. # write the mapping to a file
  219. msg_packet_mapping.write_to(context.allocate_file("_mapping.xml"))
  220. # Store timestamp of last packet
  221. self.attack_end_utime = last_packet.time
  222. # Return packets sorted by packet by timestamp and total number of packets (sent)
  223. return total_pkts , path_attack_pcap
  224. def _create_messages(self, context):
  225. """
  226. Creates the messages that are to be injected into the PCAP.
  227. :param context: the context of the attack, containing e.g. files that are to be created
  228. :return: the final messages as a list
  229. """
  230. def add_ids_to_config(ids_to_add: list, existing_ips: list, new_ips: list, bot_configs: dict, idtype:str="local", router_mac:str=""):
  231. """
  232. Creates IP and MAC configurations for the given IDs and adds them to the existing configurations object.
  233. :param ids_to_add: all sorted IDs that have to be configured and added
  234. :param existing_ips: the existing IPs in the PCAP file that should be assigned to some, or all, IDs
  235. :param new_ips: the newly generated IPs that should be assigned to some, or all, IDs
  236. :param bot_configs: the existing configurations for the bots
  237. :param idtype: the locality type of the IDs
  238. :param router_mac: the MAC address of the router in the PCAP
  239. """
  240. ids = ids_to_add.copy()
  241. # macgen only needed, when IPs are new local IPs (therefore creating the object here suffices for the current callers
  242. # to not end up with the same MAC paired with different IPs)
  243. macgen = Generator.MacAddressGenerator()
  244. # assign existing IPs and the corresponding MAC addresses in the PCAP to the IDs
  245. for ip in existing_ips:
  246. random_id = choice(ids)
  247. mac = self.statistics.process_db_query("macAddress(IPAddress=%s)" % ip)
  248. bot_configs[random_id] = {"Type": idtype, "IP": ip, "MAC": mac}
  249. ids.remove(random_id)
  250. # assign new IPs and for local IPs new MACs or for external IPs the router MAC to the IDs
  251. for ip in new_ips:
  252. random_id = choice(ids)
  253. if idtype == "local":
  254. mac = macgen.random_mac()
  255. elif idtype == "external":
  256. mac = router_mac
  257. bot_configs[random_id] = {"Type": idtype, "IP": ip, "MAC": mac}
  258. ids.remove(random_id)
  259. def index_increment(number: int, max: int):
  260. """
  261. Number increment with rollover.
  262. """
  263. if number + 1 < max:
  264. return number + 1
  265. else:
  266. return 0
  267. def assign_realistic_ttls(bot_configs:list):
  268. '''
  269. Assigns a realisitic ttl to each bot from @param: bot_configs. Uses statistics and distribution to be able
  270. to calculate a realisitc ttl.
  271. :param bot_configs: List that contains all bots that should be assigned with realistic ttls.
  272. '''
  273. ids = sorted(bot_configs.keys())
  274. for pos,bot in enumerate(ids):
  275. bot_type = bot_configs[bot]["Type"]
  276. # print(bot_type)
  277. if(bot_type == "local"): # Set fix TTL for local Bots
  278. bot_configs[bot]["TTL"] = 128
  279. # Set TTL based on TTL distribution of IP address
  280. else: # Set varying TTl for external Bots
  281. bot_ttl_dist = self.statistics.get_ttl_distribution(bot_configs[bot]["IP"])
  282. if len(bot_ttl_dist) > 0:
  283. source_ttl_prob_dict = Lea.fromValFreqsDict(bot_ttl_dist)
  284. bot_configs[bot]["TTL"] = source_ttl_prob_dict.random()
  285. else:
  286. bot_configs[bot]["TTL"] = self.statistics.process_db_query("most_used(ttlValue)")
  287. def assign_realistic_timestamps(messages: list, external_ids: set, local_ids: set, avg_delay_local:float, avg_delay_external: float, zero_reference:float):
  288. """
  289. Assigns realistic timestamps to a set of messages
  290. :param messages: the set of messages to be updated
  291. :param external_ids: the set of bot ids, that are outside the network, i.e. external
  292. :param local_ids: the set of bot ids, that are inside the network, i.e. local
  293. :avg_delay_local: the avg_delay between the dispatch and the reception of a packet between local computers
  294. :avg_delay_external: the avg_delay between the dispatch and the reception of a packet between a local and an external computer
  295. :zero_reference: the timestamp which is regarded as the beginning of the pcap_file and therefore handled like a timestamp that resembles 0
  296. """
  297. updated_msgs = []
  298. last_response = {} # Dict, takes a tuple of 2 Bot_IDs as a key (requester, responder), returns the time of the last response, the requester received
  299. # necessary in order to make sure, that additional requests are sent only after the response to the last one was received
  300. for msg in messages: # init
  301. last_response[(msg.src, msg.dst)] = -1
  302. # update all timestamps
  303. for req_msg in messages:
  304. if(req_msg in updated_msgs):
  305. # message already updated
  306. continue
  307. # if req_msg.timestamp would be before the timestamp of the response to the last request, req_msg needs to be sent later (else branch)
  308. if last_response[(req_msg.src, req_msg.dst)] == -1 or last_response[(req_msg.src, req_msg.dst)] < (zero_reference + req_msg.time - 0.05):
  309. ## update req_msg timestamp with a variation of up to 50ms
  310. req_msg.time = zero_reference + req_msg.time + uniform(-0.05, 0.05)
  311. updated_msgs.append(req_msg)
  312. else:
  313. req_msg.time = last_response[(req_msg.src, req_msg.dst)] + 0.06 + uniform(-0.05, 0.05)
  314. # update response if necessary
  315. if req_msg.refer_msg_id != -1:
  316. respns_msg = messages[req_msg.refer_msg_id]
  317. # check for local or external communication and update response timestamp with the respective avg delay
  318. if req_msg.src in external_ids or req_msg.dst in external_ids:
  319. #external communication
  320. respns_msg.time = req_msg.time + avg_delay_external + uniform(-0.1*avg_delay_external, 0.1*avg_delay_external)
  321. else:
  322. #local communication
  323. respns_msg.time = req_msg.time + avg_delay_local + uniform(-0.1*avg_delay_local, 0.1*avg_delay_local)
  324. updated_msgs.append(respns_msg)
  325. last_response[(req_msg.src, req_msg.dst)] = respns_msg.time
  326. def assign_ttls_from_caida(bot_configs):
  327. """
  328. Assign realistic TTL values to bots with respect to their IP, based on the CAIDA dataset.
  329. If there exists an entry for a bot's IP, the TTL is chosen based on a distribution over all used TTLs by this IP.
  330. If there is no such entry, the TTL is chosen based on a distribution over all used TTLs and their respective frequency.
  331. :param bot_configs: the existing bot configurations
  332. """
  333. def get_ip_ttl_distrib():
  334. """
  335. Parses the CSV file containing a mapping between IP and their used TTLs.
  336. :return: returns a dict with the IPs as keys and dicts for their TTL disribution as values
  337. """
  338. ip_based_distrib = {}
  339. with open("resources/CaidaTTL_perIP.csv", "r") as file:
  340. # every line consists of: IP, TTL, Frequency
  341. next(file) # skip CSV header line
  342. for line in file:
  343. ip_addr, ttl, freq = line.split(",")
  344. if ip_addr not in ip_based_distrib:
  345. ip_based_distrib[ip_addr] = {} # the values for ip_based_distrib are dicts with key=TTL, value=Frequency
  346. ip_based_distrib[ip_addr][ttl] = int(freq)
  347. return ip_based_distrib
  348. def get_total_ttl_distrib():
  349. """
  350. Parses the CSV file containing an overview of all used TTLs and their respective frequency.
  351. :return: returns a dict with the TTLs as keys and their frequencies as keys
  352. """
  353. total_ttl_distrib = {}
  354. with open("resources/CaidaTTL_total.csv", "r") as file:
  355. # every line consists of: TTL, Frequency, Fraction
  356. next(file) # skip CSV header line
  357. for line in file:
  358. ttl, freq, _ = line.split(",")
  359. total_ttl_distrib[ttl] = int(freq)
  360. return total_ttl_distrib
  361. # get the TTL distribution for every IP that is available in "resources/CaidaTTL_perIP.csv"
  362. ip_ttl_distrib = get_ip_ttl_distrib()
  363. # build a probability dict for the total TTL distribution
  364. total_ttl_prob_dict = Lea.fromValFreqsDict(get_total_ttl_distrib())
  365. # loop over every bot id and assign a TTL to the respective bot
  366. for bot_id in sorted(bot_configs):
  367. bot_type = bot_configs[bot_id]["Type"]
  368. bot_ip = bot_configs[bot_id]["IP"]
  369. if bot_type == "local":
  370. bot_configs[bot_id]["TTL"] = 128
  371. # if there exists detailed information about the TTL distribution of this IP
  372. elif bot_ip in ip_ttl_distrib:
  373. ip_ttl_freqs = ip_ttl_distrib[bot_ip]
  374. source_ttl_prob_dict = Lea.fromValFreqsDict(ip_ttl_freqs) # build a probability dict from this IP's TTL distribution
  375. bot_configs[bot_id]["TTL"] = source_ttl_prob_dict.random()
  376. # otherwise assign a random TTL based on the total TTL distribution
  377. else:
  378. bot_configs[bot_id]["TTL"] = total_ttl_prob_dict.random()
  379. def move_xml_to_outdir(filepath_xml: str):
  380. """
  381. Moves the XML file at filepath_xml to the output directory of the PCAP
  382. :param filepath_xml: the filepath to the XML file
  383. :return: the new filepath to the XML file
  384. """
  385. pcap_dir = context.get_output_dir()
  386. xml_name = os.path.basename(filepath_xml)
  387. if pcap_dir.endswith("/"):
  388. new_xml_path = pcap_dir + xml_name
  389. else:
  390. new_xml_path = pcap_dir + "/" + xml_name
  391. os.rename(filepath_xml, new_xml_path)
  392. context.add_other_created_file(new_xml_path)
  393. return new_xml_path
  394. # parse input CSV or XML
  395. filepath_xml = self.get_param_value(Param.FILE_XML)
  396. filepath_csv = self.get_param_value(Param.FILE_CSV)
  397. # use C++ communication processor for faster interval finding
  398. cpp_comm_proc = lb.botnet_comm_processor();
  399. # only use CSV input if the XML path is the default one
  400. # --> prefer XML input over CSV input (in case both are given)
  401. print_updates = False
  402. if filepath_csv and filepath_xml == self.DEFAULT_XML_PATH:
  403. filename = os.path.splitext(filepath_csv)[0]
  404. filesize = os.path.getsize(filepath_csv) / 2**20 # get filesize in MB
  405. if filesize > 10:
  406. print("\nParsing input CSV file...", end=" ")
  407. sys.stdout.flush()
  408. print_updates = True
  409. cpp_comm_proc.parse_csv(filepath_csv)
  410. if print_updates:
  411. print("done.")
  412. print("Writing corresponding XML file...", end=" ")
  413. sys.stdout.flush()
  414. filepath_xml = cpp_comm_proc.write_xml(filename)
  415. filepath_xml = move_xml_to_outdir(filepath_xml)
  416. if print_updates: print("done.")
  417. else:
  418. filesize = os.path.getsize(filepath_xml) / 2**20 # get filesize in MB
  419. if filesize > 10:
  420. print("Parsing input XML file...", end=" ")
  421. sys.stdout.flush()
  422. print_updates = True
  423. cpp_comm_proc.parse_xml(filepath_xml)
  424. if print_updates: print("done.")
  425. # find a good communication mapping in the input file that matches the users parameters
  426. nat = self.get_param_value(Param.NAT_PRESENT)
  427. comm_proc = CommunicationProcessor(self.msg_types, nat)
  428. duration = self.get_param_value(Param.ATTACK_DURATION)
  429. number_init_bots = self.get_param_value(Param.NUMBER_INITIATOR_BOTS)
  430. strategy = self.get_param_value(Param.INTERVAL_SELECT_STRATEGY)
  431. start_idx = self.get_param_value(Param.INTERVAL_SELECT_START)
  432. end_idx = self.get_param_value(Param.INTERVAL_SELECT_END)
  433. potential_long_find_time = (strategy == "optimal" and (filesize > 4 and self.statistics.get_packet_count() > 1000))
  434. if print_updates or potential_long_find_time:
  435. if not print_updates: print()
  436. print("Selecting communication interval from input CSV/XML file...", end=" ")
  437. sys.stdout.flush()
  438. if potential_long_find_time:
  439. print("\nWarning: Because of the large input files and the (chosen) interval selection strategy 'optimal',")
  440. print("this may take a while. Consider using selection strategy 'random' or 'custom'...", end=" ")
  441. sys.stdout.flush()
  442. print_updates = True
  443. comm_interval = comm_proc.get_comm_interval(cpp_comm_proc, strategy, number_init_bots, duration, start_idx, end_idx)
  444. if not comm_interval:
  445. print("Error: An interval that satisfies the input cannot be found.")
  446. return []
  447. if print_updates: print("done.") # print corresponding message to interval finding message
  448. # retrieve the mapping information
  449. mapped_ids, packet_start_idx, packet_end_idx = comm_interval["IDs"], comm_interval["Start"], comm_interval["End"]
  450. # print(mapped_ids)
  451. while len(mapped_ids) > number_init_bots:
  452. rm_idx = randrange(0, len(mapped_ids))
  453. del mapped_ids[rm_idx]
  454. if print_updates: print("Generating attack packets...", end=" ")
  455. sys.stdout.flush()
  456. # get the messages contained in the chosen interval
  457. abstract_packets = cpp_comm_proc.get_messages(packet_start_idx, packet_end_idx);
  458. comm_proc.set_mapping(abstract_packets, mapped_ids)
  459. # determine ID roles and select the messages that are to be mapped into the PCAP
  460. messages = comm_proc.det_id_roles_and_msgs()
  461. # use the previously detetermined roles to assign the locality of all IDs
  462. local_ids, external_ids = comm_proc.det_ext_and_local_ids()
  463. # print start and end time of mapped interval
  464. # print(abstract_packets[packet_start_idx]["Time"])
  465. # print(abstract_packets[packet_end_idx]["Time"])
  466. # print(mapped_ids)
  467. # determine number of reused local and external IPs
  468. reuse_percent_total = self.get_param_value(Param.IP_REUSE_TOTAL)
  469. reuse_percent_external = self.get_param_value(Param.IP_REUSE_EXTERNAL)
  470. reuse_percent_local = self.get_param_value(Param.IP_REUSE_LOCAL)
  471. reuse_count_external = int(reuse_percent_total * reuse_percent_external * len(mapped_ids))
  472. reuse_count_local = int(reuse_percent_total * reuse_percent_local * len(mapped_ids))
  473. # create IP and MAC configurations for the IDs/Bots
  474. ipgen = Generator.IPGenerator()
  475. pcapops = PcapAddressOperations(self.statistics)
  476. router_mac = pcapops.get_probable_router_mac()
  477. bot_configs = {}
  478. # retrieve and assign the IPs and MACs for the bots with respect to the given parameters
  479. # (IDs are always added to bot_configs in the same order under a given seed)
  480. number_local_ids, number_external_ids = len(local_ids), len(external_ids)
  481. # assign addresses for local IDs
  482. if number_local_ids > 0:
  483. reuse_count_local = int(reuse_percent_total * reuse_percent_local * number_local_ids)
  484. existing_local_ips = sorted(pcapops.get_existing_local_ips(reuse_count_local))
  485. new_local_ips = sorted(pcapops.get_new_local_ips(number_local_ids - len(existing_local_ips)))
  486. add_ids_to_config(sorted(local_ids), existing_local_ips, new_local_ips, bot_configs)
  487. # assign addresses for external IDs
  488. if number_external_ids > 0:
  489. reuse_count_external = int(reuse_percent_total * reuse_percent_external * number_external_ids)
  490. existing_external_ips = sorted(pcapops.get_existing_external_ips(reuse_count_external))
  491. remaining = len(external_ids) - len(existing_external_ips)
  492. for external_ip in existing_external_ips: ipgen.add_to_blacklist(external_ip)
  493. new_external_ips = sorted([ipgen.random_ip() for _ in range(remaining)])
  494. add_ids_to_config(sorted(external_ids), existing_external_ips, new_external_ips, bot_configs, idtype="external", router_mac=router_mac)
  495. # this is the timestamp at which the first packet should be injected, the packets have to be shifted to the beginning of the
  496. # pcap file (INJECT_AT_TIMESTAMP) and then the offset of the packets have to be compensated to start at the given point in time
  497. zero_reference = self.get_param_value(Param.INJECT_AT_TIMESTAMP) - messages[0].time
  498. # calculate the average delay values for local and external responses
  499. avg_delay_local, avg_delay_external = self.statistics.get_avg_delay_local_ext()
  500. #set timestamps
  501. assign_realistic_timestamps(messages, external_ids, local_ids, avg_delay_local, avg_delay_external, zero_reference)
  502. portSelector = PortSelectors.LINUX
  503. # create port configurations for the bots
  504. calculate_dst_port = self.get_param_value(Param.BOTNET_DST_PORT_CALCULATION)
  505. for bot in sorted(bot_configs):
  506. bot_configs[bot]["SrcPort"] = portSelector.select_port_udp()
  507. if calculate_dst_port:
  508. bot_configs[bot]["DstPort"] = Generator.gen_random_server_port()
  509. else:
  510. bot_configs[bot]["DstPort"] = portSelector.select_port_udp()
  511. # assign realistic TTL for every bot
  512. if self.get_param_value(Param.TTL_FROM_CAIDA):
  513. assign_ttls_from_caida(bot_configs)
  514. else:
  515. assign_realistic_ttls(bot_configs)
  516. # put together the final messages including the full sender and receiver
  517. # configurations (i.e. IP, MAC, port, ...) for easier later use
  518. final_messages = []
  519. messages = sorted(messages, key=lambda msg: msg.time)
  520. new_id = 0
  521. for msg in messages:
  522. type_src, type_dst = bot_configs[msg.src]["Type"], bot_configs[msg.dst]["Type"]
  523. id_src, id_dst = msg.src, msg.dst
  524. # sort out messages that do not have a suitable locality setting
  525. if type_src == "external" and type_dst == "external":
  526. continue
  527. msg.src, msg.dst = bot_configs[id_src], bot_configs[id_dst]
  528. msg.src["ID"], msg.dst["ID"] = id_src, id_dst
  529. msg.msg_id = new_id
  530. new_id += 1
  531. ### Important here to update refers, if needed later?
  532. final_messages.append(msg)
  533. return final_messages
  534. def _get_capture_duration(self):
  535. """
  536. Returns the duration of the input PCAP (since statistics duration seems to be incorrect)
  537. """
  538. ts_date_format = "%Y-%m-%d %H:%M:%S.%f"
  539. ts_first_date = datetime.strptime(self.statistics.get_pcap_timestamp_start(), ts_date_format)
  540. ts_last_date = datetime.strptime(self.statistics.get_pcap_timestamp_end(), ts_date_format)
  541. diff_date = ts_last_date - ts_first_date
  542. duration = "%d.%d" % (diff_date.total_seconds(), diff_date.microseconds)
  543. return duration