3
0

Utility.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. import calendar as cal
  2. import datetime as dt
  3. import ipaddress
  4. import os
  5. import random as rnd
  6. import matplotlib
  7. import scipy.stats as stats
  8. matplotlib.use('Agg', force=True)
  9. import lea
  10. import scapy.layers.inet as inet
  11. CODE_DIR = os.path.dirname(os.path.abspath(__file__)) + "/../"
  12. ROOT_DIR = CODE_DIR + "../"
  13. RESOURCE_DIR = ROOT_DIR + "resources/"
  14. TEST_DIR = RESOURCE_DIR + "test/"
  15. platforms = {"win7", "win10", "winxp", "win8.1", "macos", "linux", "win8", "winvista", "winnt", "win2000"}
  16. platform_probability = {"win7": 48.43, "win10": 27.99, "winxp": 6.07, "win8.1": 6.07, "macos": 5.94, "linux": 3.38,
  17. "win8": 1.35, "winvista": 0.46, "winnt": 0.31}
  18. x86_nops = {b'\x90', b'\xfc', b'\xfd', b'\xf8', b'\xf9', b'\xf5', b'\x9b'}
  19. x86_pseudo_nops = {b'\x97', b'\x96', b'\x95', b'\x93', b'\x92', b'\x91', b'\x99', b'\x4d', b'\x48', b'\x47', b'\x4f',
  20. b'\x40', b'\x41', b'\x37', b'\x3f', b'\x27', b'\x2f', b'\x46', b'\x4e', b'\x98', b'\x9f', b'\x4a',
  21. b'\x44', b'\x42', b'\x43', b'\x49', b'\x4b', b'\x45', b'\x4c', b'\x60', b'\x0e', b'\x1e', b'\x50',
  22. b'\x55', b'\x53', b'\x51', b'\x57', b'\x52', b'\x06', b'\x56', b'\x54', b'\x16', b'\x58', b'\x5d',
  23. b'\x5b', b'\x59', b'\x5f', b'\x5a', b'\x5e', b'\xd6'}
  24. forbidden_chars = [b'\x00', b'\x0a', b'\x0d']
  25. attacker_port_mapping = {}
  26. attacker_ttl_mapping = {}
  27. def update_timestamp(timestamp, pps, delay=0):
  28. """
  29. Calculates the next timestamp to be used based on the packet per second rate (pps) and the maximum delay.
  30. :return: Timestamp to be used for the next packet.
  31. """
  32. if delay == 0:
  33. # Calculate request timestamp
  34. # To imitate the bursty behavior of traffic
  35. randomdelay = lea.Lea.fromValFreqsDict({1 / pps: 70, 2 / pps: 20, 5 / pps: 7, 10 / pps: 3})
  36. return timestamp + rnd.uniform(1 / pps, randomdelay.random())
  37. else:
  38. # Calculate reply timestamp
  39. randomdelay = lea.Lea.fromValFreqsDict({2 * delay: 70, 3 * delay: 20, 5 * delay: 7, 10 * delay: 3})
  40. return timestamp + rnd.uniform(1 / pps + delay, 1 / pps + randomdelay.random())
  41. def get_interval_pps(complement_interval_pps, timestamp):
  42. """
  43. Gets the packet rate (pps) for a specific time interval.
  44. :param complement_interval_pps: an array of tuples (the last timestamp in the interval, the packet rate in the
  45. corresponding interval).
  46. :param timestamp: the timestamp at which the packet rate is required.
  47. :return: the corresponding packet rate (pps) .
  48. """
  49. for row in complement_interval_pps:
  50. if timestamp <= row[0]:
  51. return row[1]
  52. return complement_interval_pps[-1][1] # in case the timstamp > capture max timestamp
  53. def get_nth_random_element(*element_list):
  54. """
  55. Returns the n-th element of every list from an arbitrary number of given lists.
  56. For example, list1 contains IP addresses, list 2 contains MAC addresses. Use of this function ensures that
  57. the n-th IP address uses always the n-th MAC address.
  58. :param element_list: An arbitrary number of lists.
  59. :return: A tuple of the n-th element of every list.
  60. """
  61. if len(element_list) <= 0:
  62. return None
  63. elif len(element_list) == 1 and len(element_list[0]) > 0:
  64. return rnd.choice(element_list[0])
  65. else:
  66. range_max = min([len(x) for x in element_list])
  67. if range_max > 0:
  68. range_max -= 1
  69. n = rnd.randint(0, range_max)
  70. return tuple(x[n] for x in element_list)
  71. else:
  72. return None
  73. def get_rnd_os():
  74. """
  75. Chooses random platform over an operating system probability distribution
  76. :return: random platform as string
  77. """
  78. os_dist = lea.Lea.fromValFreqsDict(platform_probability)
  79. return os_dist.random()
  80. def check_platform(platform: str):
  81. """
  82. Checks if the given platform is currently supported
  83. if not exits with error
  84. :param platform: the platform, which should be validated
  85. """
  86. if platform not in platforms:
  87. print("\nERROR: Invalid platform: " + platform + "." +
  88. "\n Please select one of the following platforms: ", platforms)
  89. exit(1)
  90. def get_ip_range(start_ip: str, end_ip: str):
  91. """
  92. Generates a list of IPs of a given range. If the start_ip is greater than the end_ip, the reverse range is generated
  93. :param start_ip: the start_ip of the desired IP-range
  94. :param end_ip: the end_ip of the desired IP-range
  95. :return: a list of all IPs in the desired IP-range, including start-/end_ip
  96. """
  97. start = ipaddress.ip_address(start_ip)
  98. end = ipaddress.ip_address(end_ip)
  99. ips = []
  100. if start < end:
  101. while start <= end:
  102. ips.append(start.exploded)
  103. start = start + 1
  104. elif start > end:
  105. while start >= end:
  106. ips.append(start.exploded)
  107. start = start - 1
  108. else:
  109. ips.append(start_ip)
  110. return ips
  111. def generate_source_port_from_platform(platform: str, previous_port=0):
  112. """
  113. Generates the next source port according to the TCP-port-selection strategy of the given platform
  114. :param platform: the platform for which to generate source ports
  115. :param previous_port: the previously used/generated source port. Must be 0 if no port was generated before
  116. :return: the next source port for the given platform
  117. """
  118. check_platform(platform)
  119. if platform in {"winnt", "winxp", "win2000"}:
  120. if (previous_port == 0) or (previous_port + 1 > 5000):
  121. return rnd.randint(1024, 5000)
  122. else:
  123. return previous_port + 1
  124. elif platform == "linux":
  125. return rnd.randint(32768, 61000)
  126. else:
  127. if (previous_port == 0) or (previous_port + 1 > 65535):
  128. return rnd.randint(49152, 65535)
  129. else:
  130. return previous_port + 1
  131. def get_filetime_format(timestamp):
  132. """
  133. Converts a timestamp into MS FILETIME format
  134. :param timestamp: a timestamp in seconds
  135. :return: MS FILETIME timestamp
  136. """
  137. boot_datetime = dt.datetime.fromtimestamp(timestamp)
  138. if boot_datetime.tzinfo is None or boot_datetime.tzinfo.utcoffset(boot_datetime) is None:
  139. boot_datetime = boot_datetime.replace(tzinfo=boot_datetime.tzname())
  140. boot_filetime = 116444736000000000 + (cal.timegm(boot_datetime.timetuple()) * 10000000)
  141. return boot_filetime + (boot_datetime.microsecond * 10)
  142. def get_rnd_boot_time(timestamp, platform="winxp"):
  143. """
  144. Generates a random boot time based on a given timestamp and operating system
  145. :param timestamp: a timestamp in seconds
  146. :param platform: a platform as string as specified in check_platform above. default is winxp. this param is optional
  147. :return: timestamp of random boot time in seconds since EPOCH
  148. """
  149. check_platform(platform)
  150. if platform is "linux":
  151. uptime_in_days = lea.Lea.fromValFreqsDict({3: 50, 7: 25, 14: 12.5, 31: 6.25, 92: 3.125, 183: 1.5625,
  152. 365: 0.78125, 1461: 0.390625, 2922: 0.390625})
  153. elif platform is "macos":
  154. uptime_in_days = lea.Lea.fromValFreqsDict({7: 50, 14: 25, 31: 12.5, 92: 6.25, 183: 3.125, 365: 3.076171875,
  155. 1461: 0.048828125})
  156. else:
  157. uptime_in_days = lea.Lea.fromValFreqsDict({3: 50, 7: 25, 14: 12.5, 31: 6.25, 92: 3.125, 183: 1.5625,
  158. 365: 0.78125, 1461: 0.78125})
  159. timestamp -= rnd.randint(0, uptime_in_days.random() * 86400)
  160. return timestamp
  161. def get_rnd_x86_nop(count=1, side_effect_free=False, char_filter=set()):
  162. """
  163. Generates a specified number of x86 single-byte (pseudo-)NOPs
  164. :param count: The number of bytes to generate
  165. :param side_effect_free: Determines whether NOPs with side-effects (to registers or the stack) are allowed
  166. :param char_filter: A set of bytes which are forbidden to generate
  167. :return: Random x86 NOP bytestring
  168. """
  169. result = b''
  170. nops = x86_nops.copy()
  171. if not side_effect_free:
  172. nops |= x86_pseudo_nops.copy()
  173. if not isinstance(char_filter, set):
  174. char_filter = set(char_filter)
  175. nops = list(nops - char_filter)
  176. for i in range(0, count):
  177. result += nops[rnd.randint(0, len(nops) - 1)]
  178. return result
  179. def get_rnd_bytes(count=1, ignore=None):
  180. """
  181. Generates a specified number of random bytes while excluding unwanted bytes
  182. :param count: Number of wanted bytes
  183. :param ignore: The bytes, which should be ignored, as an array
  184. :return: Random bytestring
  185. """
  186. if ignore is None:
  187. ignore = []
  188. result = b''
  189. for i in range(0, count):
  190. char = os.urandom(1)
  191. while char in ignore:
  192. char = os.urandom(1)
  193. result += char
  194. return result
  195. def check_payload_len(payload_len: int, limit: int):
  196. """
  197. Checks if the len of the payload exceeds a given limit
  198. :param payload_len: The length of the payload
  199. :param limit: The limit of the length of the payload which is allowed
  200. """
  201. if payload_len > limit:
  202. print("\nCustom payload too long: ", payload_len, " bytes. Should be a maximum of ", limit, " bytes.")
  203. exit(1)
  204. def get_bytes_from_file(filepath):
  205. """
  206. Converts the content of a file into its byte representation
  207. The content of the file can either be a string or hexadecimal numbers/bytes (e.g. shellcode)
  208. The file must have the keyword "str" or "hex" in its first line to specify the rest of the content
  209. If the content is hex, whitespaces, backslashes, "x", quotation marks and "+" are removed
  210. Example for a hexadecimal input file:
  211. hex
  212. "abcd ef \xff10\ff 'xaa' x \ ab"
  213. Output: b'\xab\xcd\xef\xff\x10\xff\xaa\xab'
  214. :param filepath: The path of the file from which to get the bytes
  215. :return: The bytes of the file (either a byte representation of a string or the bytes contained in the file)
  216. """
  217. try:
  218. file = open(filepath)
  219. result_bytes = b''
  220. header = file.readline().strip()
  221. content = file.read()
  222. if header == "hex":
  223. content = content.replace(" ", "").replace("\n", "").replace("\\", "").replace("x", "").replace("\"", "") \
  224. .replace("'", "").replace("+", "").replace("\r", "")
  225. try:
  226. result_bytes = bytes.fromhex(content)
  227. except ValueError:
  228. print("\nERROR: Content of file is not all hexadecimal.")
  229. file.close()
  230. exit(1)
  231. elif header == "str":
  232. result_bytes = content.strip().encode()
  233. else:
  234. print("\nERROR: Invalid header found: " + header + ". Try 'hex' or 'str' followed by endline instead.")
  235. file.close()
  236. exit(1)
  237. for forbidden_char in forbidden_chars:
  238. if forbidden_char in result_bytes:
  239. print("\nERROR: Forbidden character found in payload: ", forbidden_char)
  240. file.close()
  241. exit(1)
  242. file.close()
  243. return result_bytes
  244. except FileNotFoundError:
  245. print("\nERROR: File not found: ", filepath)
  246. exit(1)
  247. def handle_most_used_outputs(most_used_x):
  248. """
  249. :param most_used_x: Element or list (e.g. from SQL-query output) which should only be one element
  250. :return: most_used_x if it's not a list. The first element of most_used_x after being sorted if it's a list.
  251. None if that list is empty.
  252. """
  253. if isinstance(most_used_x, list):
  254. if len(most_used_x) == 0:
  255. return None
  256. most_used_x.sort()
  257. return most_used_x[0]
  258. else:
  259. return most_used_x
  260. def get_attacker_config(ip_source_list, ip_address: str):
  261. """
  262. Returns the attacker configuration depending on the IP address, this includes the port for the next
  263. attacking packet and the previously used (fixed) TTL value.
  264. :param ip_source_list: List of source IPs
  265. :param ip_address: The IP address of the attacker
  266. :return: A tuple consisting of (port, ttlValue)
  267. """
  268. # Gamma distribution parameters derived from MAWI 13.8G dataset
  269. alpha, loc, beta = (2.3261710235, -0.188306914406, 44.4853123884)
  270. gd = stats.gamma.rvs(alpha, loc=loc, scale=beta, size=len(ip_source_list))
  271. # Determine port
  272. port = attacker_port_mapping.get(ip_address)
  273. if port is not None: # use next port
  274. next_port = attacker_port_mapping.get(ip_address) + 1
  275. if next_port > (2 ** 16 - 1):
  276. next_port = 1
  277. else: # generate starting port
  278. next_port = inet.RandShort()
  279. attacker_port_mapping[ip_address] = next_port
  280. # Determine TTL value
  281. ttl = attacker_ttl_mapping.get(ip_address)
  282. if ttl is None: # determine TTL value
  283. is_invalid = True
  284. pos = ip_source_list.index(ip_address)
  285. pos_max = len(gd)
  286. while is_invalid:
  287. ttl = int(round(gd[pos]))
  288. if 0 < ttl < 256: # validity check
  289. is_invalid = False
  290. else:
  291. pos = (pos + 1) % pos_max
  292. attacker_ttl_mapping[ip_address] = ttl
  293. # return port and TTL
  294. return next_port, ttl
  295. def rchop(string, endings):
  296. """"
  297. Returns the input string with it's ending cut off, in case it was part of 'endings'
  298. :param string: Input string
  299. :param endings: List of possible endings to be cut off
  300. :return: Input string with ending cut off
  301. """
  302. for end in endings:
  303. if string.endswith(end):
  304. return string[:-len(end)]
  305. return string