BaseAttack.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  1. import ipaddress
  2. import os
  3. import random
  4. import re
  5. import tempfile
  6. from abc import abstractmethod, ABCMeta
  7. import ID2TLib.libpcapreader as pr
  8. from scapy.utils import PcapWriter
  9. from Attack import AttackParameters
  10. from Attack.AttackParameters import Parameter
  11. from Attack.AttackParameters import ParameterTypes
  12. class BaseAttack(metaclass=ABCMeta):
  13. """
  14. Abstract base class for all attack classes. Provides basic functionalities, like parameter validation.
  15. """
  16. def __init__(self, statistics, name, description, attack_type):
  17. """
  18. To be called within the individual attack class to initialize the required parameters.
  19. :param statistics: A reference to the Statistics class.
  20. :param name: The name of the attack class.
  21. :param description: A short description of the attack.
  22. :param attack_type: The type the attack belongs to, like probing/scanning, malware.
  23. """
  24. # Reference to statistics class
  25. self.statistics = statistics
  26. # Class fields
  27. self.attack_name = name
  28. self.attack_description = description
  29. self.attack_type = attack_type
  30. self.params = {}
  31. self.supported_params = {}
  32. self.attack_start_utime = 0
  33. self.attack_end_utime = 0
  34. @abstractmethod
  35. def generate_attack_pcap(self):
  36. """
  37. Creates a pcap containing the attack packets.
  38. :return: The location of the generated pcap file.
  39. """
  40. pass
  41. ################################################
  42. # HELPER VALIDATION METHODS
  43. # Used to validate the given parameter values
  44. ################################################
  45. @staticmethod
  46. def _is_mac_address(mac_address: str):
  47. """
  48. Verifies if the given string is a valid MAC address. Accepts the formats 00:80:41:ae:fd:7e and 00-80-41-ae-fd-7e.
  49. :param mac_address: The MAC address as string.
  50. :return: True if the MAC address is valid, otherwise False.
  51. """
  52. pattern = re.compile('^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$', re.MULTILINE)
  53. if isinstance(mac_address, list):
  54. for mac in mac_address:
  55. if re.match(pattern, mac) is None:
  56. return False
  57. else:
  58. if re.match(pattern, mac_address) is None:
  59. return False
  60. return True
  61. @staticmethod
  62. def _is_ip_address(ip_address: str):
  63. """
  64. Verifies that the given string or list of IP addresses (strings) is a valid IPv4/IPv6 address.
  65. Accepts comma-separated lists of IP addresses, like "192.169.178.1, 192.168.178.2"
  66. :param ip_address: The IP address(es) as list of strings or comma-separated string.
  67. :return: True if all IP addresses are valid, otherwise False. And a list of IP addresses as string.
  68. """
  69. ip_address_output = []
  70. # a comma-separated list of IP addresses must be splitted first
  71. if isinstance(ip_address, str):
  72. ip_address = ip_address.split(',')
  73. for ip in ip_address:
  74. try:
  75. ipaddress.ip_address(ip)
  76. ip_address_output.append(ip)
  77. except ValueError:
  78. return False, ip_address_output
  79. if len(ip_address_output) == 1:
  80. return True, ip_address_output[0]
  81. else:
  82. return True, ip_address_output
  83. @staticmethod
  84. def _is_port(ports_input: str):
  85. """
  86. Verifies if the given value is a valid port. Accepts port ranges, like 80-90, 80..99, 80...99.
  87. :param ports_input: The port number as int or string.
  88. :return: True if the port number is valid, otherwise False. If a single port or a comma-separated list of ports
  89. was given, a list of int is returned. If a port range was given, the range is resolved
  90. and a list of int is returned.
  91. """
  92. def _is_invalid_port(num):
  93. """
  94. Checks whether the port number is invalid.
  95. :param num: The port number as int.
  96. :return: True if the port number is invalid, otherwise False.
  97. """
  98. return num < 1 or num > 65535
  99. if isinstance(ports_input, str):
  100. ports_input = ports_input.replace(' ', '').split(',')
  101. elif isinstance(ports_input, int):
  102. ports_input = [ports_input]
  103. ports_output = []
  104. for port_entry in ports_input:
  105. if isinstance(port_entry, int):
  106. if _is_invalid_port(port_entry):
  107. return False
  108. ports_output.append(port_entry)
  109. elif isinstance(port_entry, str) and port_entry.isdigit():
  110. # port_entry describes a single port
  111. port_entry = int(port_entry)
  112. if _is_invalid_port(port_entry):
  113. return False
  114. ports_output.append(port_entry)
  115. elif '-' in port_entry or '..' in port_entry:
  116. # port_entry describes a port range
  117. # allowed format: '1-49151', '1..49151', '1...49151'
  118. match = re.match('^([0-9]{1,5})(?:-|\.{2,3})([0-9]{1,5})$', port_entry)
  119. # check validity of port range
  120. # and create list of ports derived from given start and end port
  121. (port_start, port_end) = int(match.group(1)), int(match.group(2))
  122. if _is_invalid_port(port_start) or _is_invalid_port(port_end):
  123. return False
  124. else:
  125. ports_list = [i for i in range(port_start, port_end + 1)]
  126. # append ports at ports_output list
  127. ports_output += ports_list
  128. if len(ports_output) == 1:
  129. return True, ports_output[0]
  130. else:
  131. return True, ports_output
  132. @staticmethod
  133. def _is_timestamp(timestamp: str):
  134. """
  135. Checks whether the given value is in a valid timestamp format. The accepted format is:
  136. YYYY-MM-DD h:m:s, whereas h, m, s may be one or two digits.
  137. :param timestamp: The timestamp to be checked.
  138. :return: True if the timestamp is valid, otherwise False.
  139. """
  140. is_valid = re.match('[0-9]{4}(?:-[0-9]{1,2}){2} (?:[0-9]{1,2}:){2}[0-9]{1,2}', timestamp)
  141. return is_valid is not None
  142. @staticmethod
  143. def _is_boolean(value):
  144. """
  145. Checks whether the given value (string or bool) is a boolean. Strings are valid booleans if they are in:
  146. {y, yes, t, true, on, 1, n, no, f, false, off, 0}.
  147. :param value: The value to be checked.
  148. :return: True if the value is a boolean, otherwise false. And the casted boolean.
  149. """
  150. # If value is already a boolean
  151. if isinstance(value, bool):
  152. return True, value
  153. # If value is a string
  154. # True values are y, yes, t, true, on and 1;
  155. # False values are n, no, f, false, off and 0.
  156. # Raises ValueError if value is anything else.
  157. try:
  158. import distutils.core
  159. value = distutils.util.strtobool(value.lower())
  160. is_bool = True
  161. except ValueError:
  162. is_bool = False
  163. return is_bool, value
  164. @staticmethod
  165. def _is_float(value):
  166. """
  167. Checks whether the given value is a float.
  168. :param value: The value to be checked.
  169. :return: True if the value is a float, otherwise False. And the casted float.
  170. """
  171. try:
  172. value = float(value)
  173. return True, value
  174. except ValueError:
  175. return False, value
  176. #########################################
  177. # HELPER METHODS
  178. #########################################
  179. def add_param_value(self, param, value):
  180. """
  181. Adds the pair param : value to the dictionary of attack parameters. Prints and error message and skips the
  182. parameter if the validation fails.
  183. :param param: The parameter name.
  184. :param value: The parameter's value.
  185. :return: None.
  186. """
  187. # by default no param is valid
  188. is_valid = False
  189. # get AttackParameters instance associated with param
  190. # for default values assigned in attack classes, like Parameter.PORT_OPEN
  191. if isinstance(param, AttackParameters.Parameter):
  192. param_name = param
  193. # for values given by user input, like port.open
  194. else:
  195. # Get Enum key of given string identifier
  196. param_name = AttackParameters.Parameter(param)
  197. # Get parameter type of attack's required_params
  198. param_type = self.supported_params.get(param_name)
  199. # Verify validity of given value with respect to parameter type
  200. if param_type is None:
  201. print('Parameter ' + str(param_name) + ' not available for chosen attack. Skipping parameter.')
  202. # If value is query -> get value from database
  203. elif self.statistics.is_query(value):
  204. value = self.statistics.process_db_query(value, False)
  205. if value is not None and value is not "":
  206. is_valid = True
  207. else:
  208. print('Error in given parameter value: ' + value + '. Data could not be retrieved.')
  209. # Validate parameter depending on parameter's type
  210. elif param_type == ParameterTypes.TYPE_IP_ADDRESS:
  211. is_valid, value = self._is_ip_address(value)
  212. elif param_type == ParameterTypes.TYPE_PORT:
  213. is_valid, value = self._is_port(value)
  214. elif param_type == ParameterTypes.TYPE_MAC_ADDRESS:
  215. is_valid = self._is_mac_address(value)
  216. elif param_type == ParameterTypes.TYPE_INTEGER_POSITIVE:
  217. if isinstance(value, int) and int(value) >= 0:
  218. is_valid = True
  219. elif isinstance(value, str) and value.isdigit() and int(value) >= 0:
  220. is_valid = True
  221. value = int(value)
  222. elif param_type == ParameterTypes.TYPE_FLOAT:
  223. is_valid, value = self._is_float(value)
  224. # this is required to avoid that the timestamp's microseconds of the first attack packet is '000000'
  225. # but microseconds are only chosen randomly if the given parameter does not already specify it
  226. # e.g. inject.at-timestamp=123456.987654 -> is not changed
  227. # e.g. inject.at-timestamp=123456 -> is changed to: 123456.[random digits]
  228. if param_name == Parameter.INJECT_AT_TIMESTAMP and is_valid and ((value - int(value)) == 0):
  229. value = value + random.uniform(0, 0.999999)
  230. elif param_type == ParameterTypes.TYPE_TIMESTAMP:
  231. is_valid = self._is_timestamp(value)
  232. elif param_type == ParameterTypes.TYPE_BOOLEAN:
  233. is_valid, value = self._is_boolean(value)
  234. elif param_type == ParameterTypes.TYPE_PACKET_POSITION:
  235. ts = pr.pcap_processor(self.statistics.pcap_filepath).get_timestamp_mu_sec(int(value))
  236. if 0 <= int(value) <= self.statistics.get_packet_count() and ts >= 0:
  237. is_valid = True
  238. param_name = Parameter.INJECT_AT_TIMESTAMP
  239. value = (ts / 1000000) # convert microseconds from getTimestampMuSec into seconds
  240. # add value iff validation was successful
  241. if is_valid:
  242. self.params[param_name] = value
  243. else:
  244. print("ERROR: Parameter " + str(param) + " or parameter value " + str(value) +
  245. " not valid. Skipping parameter.")
  246. def get_param_value(self, param: Parameter):
  247. """
  248. Returns the parameter value for a given parameter.
  249. :param param: The parameter whose value is wanted.
  250. :return: The parameter's value.
  251. """
  252. return self.params.get(param)
  253. def check_parameters(self):
  254. """
  255. Checks whether all parameter values are defined. If a value is not defined, the application is terminated.
  256. However, this should not happen as all attack should define default parameter values.
  257. """
  258. # parameters which do not require default values
  259. non_obligatory_params = [Parameter.INJECT_AFTER_PACKET, Parameter.NUMBER_ATTACKERS]
  260. for param, type in self.supported_params.items():
  261. # checks whether all params have assigned values, INJECT_AFTER_PACKET must not be considered because the
  262. # timestamp derived from it is set to Parameter.INJECT_AT_TIMESTAMP
  263. if param not in self.params.keys() and param not in non_obligatory_params:
  264. print("\033[91mCRITICAL ERROR: Attack '" + self.attack_name + "' does not define the parameter '" +
  265. str(param) + "'.\n The attack must define default values for all parameters."
  266. + "\n Cannot continue attack generation.\033[0m")
  267. import sys
  268. sys.exit(0)
  269. def write_attack_pcap(self, packets: list, append_flag: bool = False, destination_path: str = None):
  270. """
  271. Writes the attack's packets into a PCAP file with a temporary filename.
  272. :return: The path of the written PCAP file.
  273. """
  274. # Only check params initially when attack generation starts
  275. if append_flag is False and destination_path is None:
  276. # Check if all req. parameters are set
  277. self.check_parameters()
  278. # Determine destination path
  279. if destination_path is not None and os.path.exists(destination_path):
  280. destination = destination_path
  281. else:
  282. temp_file = tempfile.NamedTemporaryFile(delete=False)
  283. destination = temp_file.name
  284. # Write packets into pcap file
  285. pktdump = PcapWriter(destination, append=append_flag)
  286. pktdump.write(packets)
  287. # Store pcap path and close file objects
  288. pktdump.close()
  289. return destination
  290. #########################################
  291. # RANDOM IP/MAC ADDRESS GENERATORS
  292. #########################################
  293. @staticmethod
  294. def generate_random_ipv4_address(n: int = 1):
  295. """
  296. Generates n random IPv4 addresses.
  297. :param n: The number of IP addresses to be generated
  298. :return: A single IP address, or if n>1, a list of IP addresses
  299. """
  300. def is_invalid(ipAddress: ipaddress.IPv4Address):
  301. return ipAddress.is_multicast or ipAddress.is_unspecified or ipAddress.is_loopback or \
  302. ipAddress.is_link_local or ipAddress.is_private or ipAddress.is_reserved
  303. def generate_address():
  304. return ipaddress.IPv4Address(random.randint(0, 2 ** 32 - 1))
  305. ip_addresses = []
  306. for i in range(0, n):
  307. address = generate_address()
  308. while is_invalid(address):
  309. address = generate_address()
  310. ip_addresses.append(str(address))
  311. if n == 1:
  312. return ip_addresses[0]
  313. else:
  314. return ip_addresses
  315. @staticmethod
  316. def generate_random_ipv6_address(n: int = 1):
  317. """
  318. Generates n random IPv6 addresses.
  319. :param n: The number of IP addresses to be generated
  320. :return: A single IP address, or if n>1, a list of IP addresses
  321. """
  322. def is_invalid(ipAddress: ipaddress.IPv6Address):
  323. return ipAddress.is_multicast or ipAddress.is_unspecified or ipAddress.is_loopback or \
  324. ipAddress.is_link_local or ipAddress.is_private or ipAddress.is_reserved
  325. def generate_address():
  326. return ipaddress.IPv6Address(random.randint(0, 2 ** 128 - 1))
  327. ip_addresses = []
  328. for i in range(0, n):
  329. address = generate_address()
  330. while is_invalid(address):
  331. address = generate_address()
  332. ip_addresses.append(str(address))
  333. if n == 1:
  334. return ip_addresses[0]
  335. else:
  336. return ip_addresses
  337. @staticmethod
  338. def generate_random_mac_address(n: int = 1):
  339. """
  340. Generates n random MAC addresses.
  341. :param n: The number of MAC addresses to be generated.
  342. :return: A single MAC addres, or if n>1, a list of MAC addresses
  343. """
  344. def is_invalid(address: str):
  345. first_octet = int(address[0:2], 16)
  346. is_multicast_address = bool(first_octet & 0b01)
  347. is_locally_administered = bool(first_octet & 0b10)
  348. return is_multicast_address or is_locally_administered
  349. def generate_address():
  350. mac = [random.randint(0x00, 0xff) for i in range(0, 6)]
  351. return ':'.join(map(lambda x: "%02x" % x, mac))
  352. mac_addresses = []
  353. for i in range(0, n):
  354. address = generate_address()
  355. while is_invalid(address):
  356. address = generate_address()
  357. mac_addresses.append(address)
  358. if n == 1:
  359. return mac_addresses[0]
  360. else:
  361. return mac_addresses