3
0

Utility.py 13 KB

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