BaseAttack.py 30 KB

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