3
0

BaseAttack.py 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864
  1. import abc
  2. import csv
  3. import hashlib
  4. import ipaddress
  5. import math
  6. import os
  7. import random
  8. import random as rnd
  9. import re
  10. import socket
  11. import sys
  12. import tempfile
  13. import time
  14. import collections
  15. import typing as t
  16. import ID2TLib.libpcapreader as pr
  17. import lea
  18. import numpy as np
  19. import scapy.layers.inet as inet
  20. import scapy.utils
  21. import Attack.AttackParameters as atkParam
  22. import ID2TLib.Utility as Util
  23. class BaseAttack(metaclass=abc.ABCMeta):
  24. """
  25. Abstract base class for all attack classes. Provides basic functionalities, like parameter validation.
  26. """
  27. ValuePair = collections.namedtuple('ValuePair', ['value', 'user_specified'])
  28. def __init__(self, name, description, attack_type):
  29. """
  30. To be called within the individual attack class to initialize the required parameters.
  31. :param name: The name of the attack class.
  32. :param description: A short description of the attack.
  33. :param attack_type: The type the attack belongs to, like probing/scanning, malware.
  34. """
  35. # Reference to statistics class
  36. self.statistics = None
  37. # Class fields
  38. self.attack_name = name
  39. self.attack_description = description
  40. self.attack_type = attack_type
  41. self.params = {}
  42. self.supported_params = {}
  43. self.attack_start_utime = 0
  44. self.attack_end_utime = 0
  45. self.start_time = 0
  46. self.finish_time = 0
  47. self.packets = []
  48. self.path_attack_pcap = ""
  49. def set_statistics(self, statistics):
  50. """
  51. Specify the statistics object that will be used to calculate the parameters of this attack.
  52. The statistics are used to calculate default parameters and to process user supplied
  53. queries.
  54. :param statistics: Reference to a statistics object.
  55. """
  56. self.statistics = statistics
  57. @abc.abstractmethod
  58. def init_params(self):
  59. """
  60. Initialize all required parameters taking into account user supplied values. If no value is supplied,
  61. or if a user defined query is supplied, use a statistics object to do the calculations.
  62. A call to this function requires a call to 'set_statistics' first.
  63. """
  64. pass
  65. @abc.abstractmethod
  66. def generate_attack_packets(self):
  67. """
  68. Creates the attack packets.
  69. """
  70. pass
  71. @abc.abstractmethod
  72. def generate_attack_pcap(self):
  73. """
  74. Creates a pcap containing the attack packets.
  75. :return: The location of the generated pcap file.
  76. """
  77. pass
  78. ################################################
  79. # HELPER VALIDATION METHODS
  80. # Used to validate the given parameter values
  81. ################################################
  82. @staticmethod
  83. def _is_mac_address(mac_address: t.Union[str, t.List[str]]) -> bool:
  84. """
  85. Verifies if the given string is a valid MAC address.
  86. Accepts the formats 00:80:41:ae:fd:7e and 00-80-41-ae-fd-7e.
  87. :param mac_address: The MAC address as string.
  88. :return: True if the MAC address is valid, otherwise False.
  89. """
  90. pattern = re.compile('^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$', re.MULTILINE)
  91. if isinstance(mac_address, list):
  92. for mac in mac_address:
  93. if re.match(pattern, mac) is None:
  94. return False
  95. else:
  96. if re.match(pattern, mac_address) is None:
  97. return False
  98. return True
  99. @staticmethod
  100. def _is_ip_address(ip_address: t.Union[str, t.List[str]]) -> t.Tuple[bool, t.Union[str, t.List[str]]]:
  101. """
  102. Verifies that the given string or list of IP addresses (strings) is a valid IPv4/IPv6 address.
  103. Accepts comma-separated lists of IP addresses, like "192.169.178.1, 192.168.178.2"
  104. :param ip_address: The IP address(es) as list of strings, comma-separated or dash-separated string.
  105. :return: True if all IP addresses are valid, otherwise False. And a list of IP addresses as string.
  106. """
  107. def append_ips(ip_address_input: t.List[str]) -> t.Tuple[bool, t.List[str]]:
  108. """
  109. Recursive appending function to handle lists and ranges of IP addresses.
  110. :param ip_address_input: The IP address(es) as list of strings, comma-separated or dash-separated string.
  111. :return: List of all given IP addresses.
  112. """
  113. ip_list = []
  114. is_valid = True
  115. for ip in ip_address_input:
  116. if '-' in ip:
  117. ip_range = ip.split('-')
  118. ip_range = Util.get_ip_range(ip_range[0], ip_range[1])
  119. is_valid, ips = append_ips(ip_range)
  120. ip_list.extend(ips)
  121. else:
  122. try:
  123. ipaddress.ip_address(ip)
  124. ip_list.append(ip)
  125. except ValueError:
  126. return False, ip_list
  127. return is_valid, ip_list
  128. # a comma-separated list of IP addresses must be split first
  129. if isinstance(ip_address, str):
  130. ip_address = ip_address.split(',')
  131. result, ip_address_output = append_ips(ip_address)
  132. if len(ip_address_output) == 1:
  133. return result, ip_address_output[0]
  134. else:
  135. return result, ip_address_output
  136. @staticmethod
  137. def _is_port(ports_input: t.Union[t.List[str], t.List[int], str, int])\
  138. -> t.Union[bool, t.Tuple[bool, t.List[t.Union[int, str]]]]:
  139. """
  140. Verifies if the given value is a valid port. Accepts port ranges, like 80-90, 80..99, 80...99.
  141. :param ports_input: The port number as int or string.
  142. :return: True if the port number is valid, otherwise False. If a single port or a comma-separated list of ports
  143. was given, a list of int is returned. If a port range was given, the range is resolved
  144. and a list of int is returned.
  145. """
  146. def _is_invalid_port(num: int) -> bool:
  147. """
  148. Checks whether the port number is invalid.
  149. :param num: The port number as int.
  150. :return: True if the port number is invalid, otherwise False.
  151. """
  152. return num < 1 or num > 65535
  153. if ports_input is None or ports_input is "":
  154. return False
  155. if isinstance(ports_input, str):
  156. ports_input = ports_input.replace(' ', '').split(',')
  157. elif isinstance(ports_input, int):
  158. ports_input = [ports_input]
  159. elif len(ports_input) is 0:
  160. return False
  161. ports_output = []
  162. for port_entry in ports_input:
  163. if isinstance(port_entry, int):
  164. if _is_invalid_port(port_entry):
  165. return False
  166. ports_output.append(port_entry)
  167. # TODO: validate last condition
  168. elif isinstance(port_entry, str) and port_entry.isdigit():
  169. # port_entry describes a single port
  170. port_entry = int(port_entry)
  171. if _is_invalid_port(port_entry):
  172. return False
  173. ports_output.append(port_entry)
  174. elif '-' in port_entry or '..' in port_entry:
  175. # port_entry describes a port range
  176. # allowed format: '1-49151', '1..49151', '1...49151'
  177. match = re.match(r'^([0-9]{1,5})(?:-|\.{2,3})([0-9]{1,5})$', str(port_entry))
  178. # check validity of port range
  179. # and create list of ports derived from given start and end port
  180. (port_start, port_end) = int(match.group(1)), int(match.group(2))
  181. if _is_invalid_port(port_start) or _is_invalid_port(port_end):
  182. return False
  183. else:
  184. ports_list = [i for i in range(port_start, port_end + 1)]
  185. # append ports at ports_output list
  186. ports_output += ports_list
  187. if len(ports_output) == 1:
  188. return True, ports_output[0]
  189. else:
  190. return True, ports_output
  191. @staticmethod
  192. def _is_timestamp(timestamp: str) -> bool:
  193. """
  194. Checks whether the given value is in a valid timestamp format. The accepted format is:
  195. YYYY-MM-DD h:m:s, whereas h, m, s may be one or two digits.
  196. :param timestamp: The timestamp to be checked.
  197. :return: True if the timestamp is valid, otherwise False.
  198. """
  199. is_valid = re.match(r'[0-9]{4}(?:-[0-9]{1,2}){2} (?:[0-9]{1,2}:){2}[0-9]{1,2}', timestamp)
  200. return is_valid is not None
  201. @staticmethod
  202. def _is_boolean(value):
  203. """
  204. Checks whether the given value (string or bool) is a boolean. Strings are valid booleans if they are in:
  205. {y, yes, t, true, on, 1, n, no, f, false, off, 0}.
  206. :param value: The value to be checked.
  207. :return: True if the value is a boolean, otherwise false. And the casted boolean.
  208. """
  209. # If value is already a boolean
  210. if isinstance(value, bool):
  211. return True, value
  212. # If value is a string
  213. # True values are y, yes, t, true, on and 1;
  214. # False values are n, no, f, false, off and 0.
  215. # Raises ValueError if value is anything else.
  216. try:
  217. import distutils.core
  218. import distutils.util
  219. value = bool(distutils.util.strtobool(value.lower()))
  220. is_bool = True
  221. except ValueError:
  222. is_bool = False
  223. return is_bool, value
  224. @staticmethod
  225. def _is_float(value):
  226. """
  227. Checks whether the given value is a float.
  228. :param value: The value to be checked.
  229. :return: True if the value is a float, otherwise False. And the casted float.
  230. """
  231. try:
  232. value = float(value)
  233. return True, value
  234. except ValueError:
  235. return False, value
  236. @staticmethod
  237. def _is_domain(val: str) -> bool:
  238. """
  239. Verifies that the given string is a valid URI.
  240. :param val: The URI as string.
  241. :return: True if URI is valid, otherwise False.
  242. """
  243. domain = re.match(r'^(?:[a-zA-Z]|[0-9]|[$-_@.&+]|[!*\(\),]|(?:%[0-9a-fA-F][0-9a-fA-F]))+$', val)
  244. return domain is not None
  245. #########################################
  246. # HELPER METHODS
  247. #########################################
  248. @staticmethod
  249. def set_seed(seed):
  250. """
  251. :param seed: The random seed to be set.
  252. """
  253. seed_final = None
  254. if isinstance(seed, int):
  255. seed_final = seed
  256. elif isinstance(seed, str):
  257. if seed.isdigit():
  258. seed_final = int(seed)
  259. else:
  260. hashed_seed = hashlib.sha1(seed.encode()).digest()
  261. seed_final = int.from_bytes(hashed_seed, byteorder="little")
  262. if seed_final:
  263. random.seed(seed_final)
  264. np.random.seed(seed_final & 0xFFFFFFFF)
  265. def set_start_time(self) -> None:
  266. """
  267. Set the current time as global starting time.
  268. """
  269. self.start_time = time.time()
  270. def set_finish_time(self) -> None:
  271. """
  272. Set the current time as global finishing time.
  273. """
  274. self.finish_time = time.time()
  275. def get_packet_generation_time(self) -> float:
  276. """
  277. :return difference between starting and finishing time.
  278. """
  279. return self.finish_time - self.start_time
  280. def add_param_value(self, param, value, user_specified: bool = True) -> None:
  281. """
  282. Adds the pair param : value to the dictionary of attack parameters. Prints and error message and skips the
  283. parameter if the validation fails.
  284. :param param: Name of the parameter that we wish to modify.
  285. :param value: The value we wish to assign to the specified parameter.
  286. :param user_specified: Whether the value was specified by the user (or left default)
  287. :return: None.
  288. """
  289. # by default no param is valid
  290. is_valid = False
  291. # get AttackParameters instance associated with param
  292. # for default values assigned in attack classes, like Parameter.PORT_OPEN
  293. if isinstance(param, atkParam.Parameter):
  294. param_name = param
  295. # for values given by user input, like port.open
  296. else:
  297. # Get Enum key of given string identifier
  298. param_name = atkParam.Parameter(param)
  299. # Get parameter type of attack's required_params
  300. param_type = self.supported_params.get(param_name)
  301. # Verify validity of given value with respect to parameter type
  302. if param_type is None:
  303. print('Parameter ' + str(param_name) + ' not available for chosen attack. Skipping parameter.')
  304. # If value is query -> get value from database
  305. elif param_name != atkParam.Parameter.INTERVAL_SELECT_STRATEGY and self.statistics.is_query(value):
  306. value = self.statistics.process_db_query(value, False)
  307. if value is not None and value is not "":
  308. is_valid = True
  309. else:
  310. print('Error in given parameter value: ' + str(value) + '. Data could not be retrieved.')
  311. # Validate parameter depending on parameter's type
  312. elif param_type == atkParam.ParameterTypes.TYPE_IP_ADDRESS:
  313. is_valid, value = self._is_ip_address(value)
  314. elif param_type == atkParam.ParameterTypes.TYPE_PORT:
  315. is_valid, value = self._is_port(value)
  316. elif param_type == atkParam.ParameterTypes.TYPE_MAC_ADDRESS:
  317. is_valid = self._is_mac_address(value)
  318. elif param_type == atkParam.ParameterTypes.TYPE_INTEGER_POSITIVE:
  319. if isinstance(value, int) and int(value) >= 0:
  320. is_valid = True
  321. elif isinstance(value, str) and value.isdigit() and int(value) >= 0:
  322. is_valid = True
  323. value = int(value)
  324. elif param_type == atkParam.ParameterTypes.TYPE_STRING:
  325. if isinstance(value, str):
  326. is_valid = True
  327. elif param_type == atkParam.ParameterTypes.TYPE_FLOAT:
  328. is_valid, value = self._is_float(value)
  329. # this is required to avoid that the timestamp's microseconds of the first attack packet is '000000'
  330. # but microseconds are only chosen randomly if the given parameter does not already specify it
  331. # e.g. inject.at-timestamp=123456.987654 -> is not changed
  332. # e.g. inject.at-timestamp=123456 -> is changed to: 123456.[random digits]
  333. if param_name == atkParam.Parameter.INJECT_AT_TIMESTAMP and is_valid and ((value - int(value)) == 0):
  334. value = value + random.uniform(0, 0.999999)
  335. elif param_type == atkParam.ParameterTypes.TYPE_TIMESTAMP:
  336. is_valid = self._is_timestamp(value)
  337. elif param_type == atkParam.ParameterTypes.TYPE_BOOLEAN:
  338. is_valid, value = self._is_boolean(value)
  339. elif param_type == atkParam.ParameterTypes.TYPE_PACKET_POSITION:
  340. # This function call is valid only if there is a statistics object available.
  341. if self.statistics is None:
  342. print('Error: Statistics-dependent attack parameter added without setting a statistics object first.')
  343. exit(1)
  344. ts = pr.pcap_processor(self.statistics.pcap_filepath, "False").get_timestamp_mu_sec(int(value))
  345. if 0 <= int(value) <= self.statistics.get_packet_count() and ts >= 0:
  346. is_valid = True
  347. param_name = atkParam.Parameter.INJECT_AT_TIMESTAMP
  348. value = (ts / 1000000) # convert microseconds from getTimestampMuSec into seconds
  349. elif param_type == atkParam.ParameterTypes.TYPE_DOMAIN:
  350. is_valid = self._is_domain(value)
  351. elif param_type == atkParam.ParameterTypes.TYPE_FILEPATH:
  352. is_valid = os.path.isfile(value)
  353. elif param_type == atkParam.ParameterTypes.TYPE_PERCENTAGE:
  354. is_valid_float, value = self._is_float(value)
  355. if is_valid_float:
  356. is_valid = 0 <= value <= 1
  357. else:
  358. is_valid = False
  359. elif param_type == atkParam.ParameterTypes.TYPE_PADDING:
  360. if isinstance(value, int):
  361. is_valid = 0 <= value <= 100
  362. elif isinstance(value, str) and value.isdigit():
  363. value = int(value)
  364. is_valid = 0 <= value <= 100
  365. elif param_type == atkParam.ParameterTypes.TYPE_INTERVAL_SELECT_STRAT:
  366. is_valid = value in {"random", "optimal", "custom"}
  367. # add value iff validation was successful
  368. if is_valid:
  369. self.params[param_name] = self.ValuePair(value, user_specified)
  370. else:
  371. print("ERROR: Parameter " + str(param) + " or parameter value " + str(value) +
  372. " not valid. Skipping parameter.")
  373. def get_param_value(self, param: atkParam.Parameter):
  374. """
  375. Returns the parameter value for a given parameter.
  376. :param param: The parameter whose value is wanted.
  377. :return: The parameter's value.
  378. """
  379. parameter = self.params.get(param)
  380. if parameter is not None:
  381. return parameter.value
  382. else:
  383. return None
  384. def get_param_user_specified(self, param: atkParam.Parameter) -> bool:
  385. """
  386. Returns whether the parameter value was specified by the user for a given parameter.
  387. :param param: The parameter whose user-specified flag is wanted.
  388. :return: The parameter's user-specified flag.
  389. """
  390. parameter = self.params.get(param)
  391. if parameter is not None:
  392. return parameter.user_specified
  393. else:
  394. return False
  395. def check_parameters(self):
  396. """
  397. Checks whether all parameter values are defined. If a value is not defined, the application is terminated.
  398. However, this should not happen as all attack should define default parameter values.
  399. """
  400. # parameters which do not require default values
  401. non_obligatory_params = [atkParam.Parameter.INJECT_AFTER_PACKET, atkParam.Parameter.NUMBER_ATTACKERS]
  402. for param, param_type in self.supported_params.items():
  403. # checks whether all params have assigned values, INJECT_AFTER_PACKET must not be considered because the
  404. # timestamp derived from it is set to Parameter.INJECT_AT_TIMESTAMP
  405. if param not in self.params.keys() and param not in non_obligatory_params:
  406. print("\033[91mCRITICAL ERROR: Attack '" + self.attack_name + "' does not define the parameter '" +
  407. str(param) + "'.\n The attack must define default values for all parameters."
  408. + "\n Cannot continue attack generation.\033[0m")
  409. import sys
  410. sys.exit(0)
  411. def write_attack_pcap(self, packets: list, append_flag: bool = False, destination_path: str = None):
  412. """
  413. Writes the attack's packets into a PCAP file with a temporary filename.
  414. :return: The path of the written PCAP file.
  415. """
  416. # Only check params initially when attack generation starts
  417. if append_flag is False and destination_path is None:
  418. # Check if all req. parameters are set
  419. self.check_parameters()
  420. # Determine destination path
  421. if destination_path is not None and os.path.exists(destination_path):
  422. destination = destination_path
  423. else:
  424. temp_file = tempfile.NamedTemporaryFile(delete=False, suffix='.pcap')
  425. destination = temp_file.name
  426. # Write packets into pcap file
  427. pktdump = scapy.utils.PcapWriter(destination, append=append_flag)
  428. pktdump.write(packets)
  429. # Store pcap path and close file objects
  430. pktdump.close()
  431. return destination
  432. def get_reply_delay(self, ip_dst, default=2000):
  433. """
  434. Gets the minimum and the maximum reply delay for all the connections of a specific IP.
  435. :param ip_dst: The IP to reterive its reply delay.
  436. :param default: The default value to return if no delay could be fount. If < 0 raise an exception instead
  437. :return minDelay: minimum delay
  438. :return maxDelay: maximum delay
  439. """
  440. result = self.statistics.process_db_query(
  441. "SELECT AVG(minDelay), AVG(maxDelay) FROM conv_statistics WHERE ipAddressB='" + ip_dst + "';")
  442. if result[0][0] and result[0][1]:
  443. min_delay = result[0][0]
  444. max_delay = result[0][1]
  445. else:
  446. all_min_delays = self.statistics.process_db_query("SELECT minDelay FROM conv_statistics LIMIT 500;")
  447. min_delay = np.median(all_min_delays)
  448. all_max_delays = self.statistics.process_db_query("SELECT maxDelay FROM conv_statistics LIMIT 500;")
  449. max_delay = np.median(all_max_delays)
  450. if math.isnan(min_delay): # max_delay is nan too then
  451. if default < 0:
  452. raise ValueError("Could not calculate min/max_delay")
  453. min_delay = default
  454. max_delay = default
  455. min_delay = int(min_delay) * 10 ** -6 # convert from micro to seconds
  456. max_delay = int(max_delay) * 10 ** -6
  457. return min_delay, max_delay
  458. @staticmethod
  459. def packets_to_convs(exploit_raw_packets):
  460. """
  461. Classifies a bunch of packets to conversations groups. A conversation is a set of packets go between host A
  462. (IP,port) to host B (IP,port)
  463. :param exploit_raw_packets: A set of packets contains several conversations.
  464. :return conversations: A set of arrays, each array contains the packet of specific conversation
  465. :return orderList_conversations: An array contains the conversations ids (IP_A,port_A, IP_b,port_B) in the
  466. order they appeared in the original packets.
  467. """
  468. conversations = {}
  469. order_list_conversations = []
  470. for pkt_num, pkt in enumerate(exploit_raw_packets):
  471. eth_frame = inet.Ether(pkt[0])
  472. ip_pkt = eth_frame.payload
  473. ip_dst = ip_pkt.getfieldval("dst")
  474. ip_src = ip_pkt.getfieldval("src")
  475. tcp_pkt = ip_pkt.payload
  476. port_dst = tcp_pkt.getfieldval("dport")
  477. port_src = tcp_pkt.getfieldval("sport")
  478. conv_req = (ip_src, port_src, ip_dst, port_dst)
  479. conv_rep = (ip_dst, port_dst, ip_src, port_src)
  480. if conv_req not in conversations and conv_rep not in conversations:
  481. pkt_list = [pkt]
  482. conversations[conv_req] = pkt_list
  483. # Order list of conv
  484. order_list_conversations.append(conv_req)
  485. else:
  486. if conv_req in conversations:
  487. pkt_list = conversations[conv_req]
  488. pkt_list.append(pkt)
  489. conversations[conv_req] = pkt_list
  490. else:
  491. pkt_list = conversations[conv_rep]
  492. pkt_list.append(pkt)
  493. conversations[conv_rep] = pkt_list
  494. return conversations, order_list_conversations
  495. @staticmethod
  496. def is_valid_ip_address(addr):
  497. """
  498. Checks if the IP address family is supported.
  499. :param addr: IP address to be checked.
  500. :return: Boolean
  501. """
  502. try:
  503. socket.inet_aton(addr)
  504. return True
  505. except socket.error:
  506. return False
  507. @staticmethod
  508. def ip_src_dst_equal_check(ip_source, ip_destination):
  509. """
  510. Checks if the source IP and destination IP are equal.
  511. :param ip_source: source IP address.
  512. :param ip_destination: destination IP address.
  513. """
  514. equal = False
  515. if isinstance(ip_source, list):
  516. if ip_destination in ip_source:
  517. equal = True
  518. else:
  519. if ip_source == ip_destination:
  520. equal = True
  521. if equal:
  522. print("\nERROR: Invalid IP addresses; source IP is the same as destination IP: " + ip_destination + ".")
  523. sys.exit(0)
  524. @staticmethod
  525. def get_inter_arrival_time(packets, distribution: bool = False):
  526. """
  527. Gets the inter-arrival times array and its distribution of a set of packets.
  528. :param packets: the packets to extract their inter-arrival time.
  529. :param distribution: build distribution dictionary or not
  530. :return inter_arrival_times: array of the inter-arrival times
  531. :return dict: the inter-arrival time distribution as a histogram {inter-arrival time:frequency}
  532. """
  533. inter_arrival_times = []
  534. prvs_pkt_time = 0
  535. for index, pkt in enumerate(packets):
  536. timestamp = pkt[2][0] + pkt[2][1] / 10 ** 6
  537. if index == 0:
  538. prvs_pkt_time = timestamp
  539. inter_arrival_times.append(0)
  540. else:
  541. inter_arrival_times.append(timestamp - prvs_pkt_time)
  542. prvs_pkt_time = timestamp
  543. if distribution:
  544. # Build a distribution dictionary
  545. freq, values = np.histogram(inter_arrival_times, bins=20)
  546. dist_dict = {}
  547. for i, val in enumerate(values):
  548. if i < len(freq):
  549. dist_dict[str(val)] = freq[i]
  550. return inter_arrival_times, dist_dict
  551. else:
  552. return inter_arrival_times
  553. @staticmethod
  554. def clean_white_spaces(str_param):
  555. """
  556. Delete extra backslash from white spaces. This function is used to process the payload of packets.
  557. :param str_param: the payload to be processed.
  558. """
  559. str_param = str_param.replace("\\n", "\n")
  560. str_param = str_param.replace("\\r", "\r")
  561. str_param = str_param.replace("\\t", "\t")
  562. str_param = str_param.replace("\\\'", "\'")
  563. return str_param
  564. def modify_http_header(self, str_tcp_seg, orig_target_uri, target_uri, orig_ip_dst, target_host):
  565. """
  566. Substitute the URI and HOST in a HTTP header with new values.
  567. :param str_tcp_seg: the payload to be processed.
  568. :param orig_target_uri: old URI
  569. :param target_uri: new URI
  570. :param orig_ip_dst: old host
  571. :param target_host: new host
  572. """
  573. if len(str_tcp_seg) > 0:
  574. # convert payload bytes to str => str = "b'..\\r\\n..'"
  575. str_tcp_seg = str_tcp_seg[2:-1]
  576. str_tcp_seg = str_tcp_seg.replace(orig_target_uri, target_uri)
  577. str_tcp_seg = str_tcp_seg.replace(orig_ip_dst, target_host)
  578. str_tcp_seg = self.clean_white_spaces(str_tcp_seg)
  579. return str_tcp_seg
  580. def get_ip_data(self, ip_address: str):
  581. """
  582. :param ip_address: the ip of which (packet-)data shall be returned
  583. :return: MSS, TTL and Window Size values of the given IP
  584. """
  585. # Set MSS (Maximum Segment Size) based on MSS distribution of IP address
  586. mss_dist = self.statistics.get_mss_distribution(ip_address)
  587. if len(mss_dist) > 0:
  588. mss_prob_dict = lea.Lea.fromValFreqsDict(mss_dist)
  589. mss_value = mss_prob_dict.random()
  590. else:
  591. mss_value = Util.handle_most_used_outputs(self.statistics.process_db_query("most_used(mssValue)"))
  592. # Set TTL based on TTL distribution of IP address
  593. ttl_dist = self.statistics.get_ttl_distribution(ip_address)
  594. if len(ttl_dist) > 0:
  595. ttl_prob_dict = lea.Lea.fromValFreqsDict(ttl_dist)
  596. ttl_value = ttl_prob_dict.random()
  597. else:
  598. ttl_value = Util.handle_most_used_outputs(self.statistics.process_db_query("most_used(ttlValue)"))
  599. # Set Window Size based on Window Size distribution of IP address
  600. win_dist = self.statistics.get_win_distribution(ip_address)
  601. if len(win_dist) > 0:
  602. win_prob_dict = lea.Lea.fromValFreqsDict(win_dist)
  603. win_value = win_prob_dict.random()
  604. else:
  605. win_value = Util.handle_most_used_outputs(self.statistics.process_db_query("most_used(winSize)"))
  606. return mss_value, ttl_value, win_value
  607. #########################################
  608. # RANDOM IP/MAC ADDRESS GENERATORS
  609. #########################################
  610. @staticmethod
  611. def generate_random_ipv4_address(ip_class, n: int = 1):
  612. # TODO: document ip_class
  613. """
  614. Generates n random IPv4 addresses.
  615. :param ip_class:
  616. :param n: The number of IP addresses to be generated
  617. :return: A single IP address, or if n>1, a list of IP addresses
  618. """
  619. def is_invalid(ip_address_param: ipaddress.IPv4Address):
  620. """
  621. TODO FILL ME
  622. :param ip_address_param:
  623. :return:
  624. """
  625. return ip_address_param.is_multicast or ip_address_param.is_unspecified or ip_address_param.is_loopback or \
  626. ip_address_param.is_link_local or ip_address_param.is_reserved or ip_address_param.is_private
  627. # Generate a random IP from specific class
  628. def generate_address(ip_class_param):
  629. """
  630. TODO FILL ME
  631. :param ip_class_param:
  632. :return:
  633. """
  634. if ip_class_param == "Unknown":
  635. return ipaddress.IPv4Address(random.randint(0, 2 ** 32 - 1))
  636. else:
  637. # For DDoS attack, we do not generate private IPs
  638. if "private" in ip_class_param:
  639. ip_class_param = ip_class_param[0] # convert A-private to A
  640. ip_classes_byte1 = {"A": {1, 126}, "B": {128, 191}, "C": {192, 223}, "D": {224, 239}, "E": {240, 254}}
  641. temp = list(ip_classes_byte1[ip_class_param])
  642. min_b1 = temp[0]
  643. max_b1 = temp[1]
  644. b1 = random.randint(min_b1, max_b1)
  645. b2 = random.randint(1, 255)
  646. b3 = random.randint(1, 255)
  647. b4 = random.randint(1, 255)
  648. ip_address = ipaddress.IPv4Address(str(b1) + "." + str(b2) + "." + str(b3) + "." + str(b4))
  649. return ip_address
  650. ip_addresses = []
  651. for i in range(0, n):
  652. address = generate_address(ip_class)
  653. while is_invalid(address):
  654. address = generate_address(ip_class)
  655. ip_addresses.append(str(address))
  656. if n == 1:
  657. return ip_addresses[0]
  658. else:
  659. return ip_addresses
  660. @staticmethod
  661. def generate_random_ipv6_address(n: int = 1):
  662. """
  663. Generates n random IPv6 addresses.
  664. :param n: The number of IP addresses to be generated
  665. :return: A single IP address, or if n>1, a list of IP addresses
  666. """
  667. def is_invalid(ip_address: ipaddress.IPv6Address):
  668. """
  669. TODO FILL ME
  670. :param ip_address:
  671. :return:
  672. """
  673. return ip_address.is_multicast or ip_address.is_unspecified or ip_address.is_loopback or \
  674. ip_address.is_link_local or ip_address.is_private or ip_address.is_reserved
  675. def generate_address():
  676. """
  677. TODO FILL ME
  678. :return:
  679. """
  680. return ipaddress.IPv6Address(random.randint(0, 2 ** 128 - 1))
  681. ip_addresses = []
  682. for i in range(0, n):
  683. address = generate_address()
  684. while is_invalid(address):
  685. address = generate_address()
  686. ip_addresses.append(str(address))
  687. if n == 1:
  688. return ip_addresses[0]
  689. else:
  690. return ip_addresses
  691. @staticmethod
  692. def generate_random_mac_address(n: int = 1):
  693. """
  694. Generates n random MAC addresses.
  695. :param n: The number of MAC addresses to be generated.
  696. :return: A single MAC address, or if n>1, a list of MAC addresses
  697. """
  698. def is_invalid(address_param: str):
  699. first_octet = int(address_param[0:2], 16)
  700. is_multicast_address = bool(first_octet & 0b01)
  701. is_locally_administered = bool(first_octet & 0b10)
  702. return is_multicast_address or is_locally_administered
  703. def generate_address():
  704. # FIXME: cleanup
  705. mac = [random.randint(0x00, 0xff) for i in range(0, 6)]
  706. return ':'.join(map(lambda x: "%02x" % x, mac))
  707. mac_addresses = []
  708. for i in range(0, n):
  709. address = generate_address()
  710. while is_invalid(address):
  711. address = generate_address()
  712. mac_addresses.append(address)
  713. if n == 1:
  714. return mac_addresses[0]
  715. else:
  716. return mac_addresses
  717. @staticmethod
  718. def get_ports_from_nmap_service_dst(ports_num):
  719. """
  720. Read the most ports_num frequently open ports from nmap-service-tcp file to be used in the port scan.
  721. :return: Ports numbers to be used as default destination ports or default open ports in the port scan.
  722. """
  723. ports_dst = []
  724. file = open(Util.RESOURCE_DIR + 'nmap-services-tcp.csv', 'rt')
  725. spamreader = csv.reader(file, delimiter=',')
  726. for count in range(ports_num):
  727. # escape first row (header)
  728. next(spamreader)
  729. # save ports numbers
  730. ports_dst.append(next(spamreader)[0])
  731. file.close()
  732. # rnd.shuffle ports numbers partially
  733. if ports_num == 1000: # used for port.dst
  734. # FIXME: cleanup
  735. temp_array = [[0 for i in range(10)] for i in range(100)]
  736. port_dst_shuffled = []
  737. for count in range(0, 10):
  738. temp_array[count] = ports_dst[count * 100:(count + 1) * 100]
  739. rnd.shuffle(temp_array[count])
  740. port_dst_shuffled += temp_array[count]
  741. else: # used for port.open
  742. rnd.shuffle(ports_dst)
  743. port_dst_shuffled = ports_dst
  744. return port_dst_shuffled