3
0

StatsDatabase.py 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364
  1. import os.path
  2. import re
  3. import sqlite3
  4. import sys
  5. from random import randint
  6. import ID2TLib.libpcapreader as pr
  7. def dict_gen(curs: sqlite3.Cursor):
  8. """
  9. Generates a dictionary of a sqlite3.Cursor object by fetching the query's results.
  10. Taken from Python Essential Reference by David Beazley.
  11. """
  12. field_names = [d[0] for d in curs.description]
  13. while True:
  14. rows = curs.fetchmany()
  15. if not rows:
  16. return
  17. for row in rows:
  18. yield dict(zip(field_names, row))
  19. class StatsDatabase:
  20. def __init__(self, db_path: str):
  21. """
  22. Creates a new StatsDatabase.
  23. :param db_path: The path to the database file
  24. """
  25. self.existing_db = os.path.exists(db_path)
  26. self.database = sqlite3.connect(db_path)
  27. self.cursor = self.database.cursor()
  28. # If DB not existing, create a new DB scheme
  29. if self.existing_db:
  30. if self.get_db_outdated():
  31. print('Statistics database outdated. Recreating database at: ', db_path)
  32. else:
  33. print('Located statistics database at: ', db_path)
  34. else:
  35. print('Statistics database not found. Creating new database at: ', db_path)
  36. def get_file_info(self):
  37. """
  38. Retrieves general file statistics from the database. This includes:
  39. - packetCount : Number of packets in the PCAP file
  40. - captureDuration : Duration of the packet capture in seconds
  41. - timestampFirstPacket : Timestamp of the first captured packet
  42. - timestampLastPacket : Timestamp of the last captured packet
  43. - avgPacketRate : Average packet rate
  44. - avgPacketSize : Average packet size
  45. - avgPacketsSentPerHost : Average number of packets sent per host
  46. - avgBandwidthIn : Average incoming bandwidth
  47. - avgBandwidthOut : Average outgoing bandwidth
  48. :return: a dictionary of keys (see above) and their respective values
  49. """
  50. return [r for r in dict_gen(
  51. self.cursor.execute('SELECT * FROM file_statistics'))][0]
  52. def get_db_exists(self):
  53. """
  54. :return: True if the database was already existent, otherwise False
  55. """
  56. return self.existing_db
  57. def get_db_outdated(self):
  58. """
  59. Retrieves the database version from the database and compares it to the version
  60. it should have to check whether the database is outdated and needs to be recreated.
  61. :return: True if the versions match, otherwise False
  62. """
  63. self.cursor.execute('PRAGMA user_version;')
  64. return self.cursor.fetchall()[0][0] != pr.pcap_processor.get_db_version()
  65. @staticmethod
  66. def _get_selector_keywords():
  67. """
  68. :return: a list of selector keywords
  69. """
  70. return ['most_used', 'least_used', 'avg', 'all']
  71. @staticmethod
  72. def _get_parametrized_selector_keywords():
  73. """
  74. :return: a list of parameterizable selector keywords
  75. """
  76. return ['ipaddress', 'macaddress']
  77. @staticmethod
  78. def _get_extractor_keywords():
  79. """
  80. :return: a list of extractor keywords
  81. """
  82. return ['random', 'first', 'last']
  83. def get_all_named_query_keywords(self):
  84. """
  85. :return: a list of all named query keywords, used to identify named queries
  86. """
  87. return (
  88. self._get_selector_keywords() + self._get_parametrized_selector_keywords() + self._get_extractor_keywords())
  89. @staticmethod
  90. def get_all_sql_query_keywords():
  91. """
  92. :return: a list of all supported SQL keywords, used to identify SQL queries
  93. """
  94. return ["select", "insert"]
  95. def _process_user_defined_query(self, query_string: str, query_parameters: tuple = None):
  96. """
  97. Takes as input a SQL query query_string and optional a tuple of parameters which are marked by '?' in the query
  98. and later substituted.
  99. :param query_string: The query to execute
  100. :param query_parameters: The tuple of parameters to inject into the query
  101. :return: the results of the query
  102. """
  103. if query_parameters is not None:
  104. self.cursor.execute(query_string, query_parameters)
  105. else:
  106. self.cursor.execute(query_string)
  107. self.database.commit()
  108. return self.cursor.fetchall()
  109. def get_field_types(self, *table_names):
  110. """
  111. Creates a dictionary whose keys are the fields of the given table(s) and whose values are the appropriate field
  112. types, like TEXT for strings and REAL for float numbers.
  113. :param table_names: The name of table(s)
  114. :return: a dictionary of {field_name : field_type} for fields of all tables
  115. """
  116. dic = {}
  117. for table in table_names:
  118. self.cursor.execute("PRAGMA table_info('%s')" % table)
  119. results = self.cursor.fetchall()
  120. for field in results:
  121. dic[field[1].lower()] = field[2]
  122. return dic
  123. def named_query_parameterized(self, keyword: str, param_op_val: list):
  124. """
  125. Executes a parameterizable named query.
  126. :param keyword: The query to be executed, like ipaddress or macadress
  127. :param param_op_val: A list consisting of triples with (parameter, operator, value)
  128. :return: the results of the executed query
  129. """
  130. named_queries = {
  131. "ipaddress": "SELECT DISTINCT ip_statistics.ipAddress from ip_statistics INNER JOIN ip_mac, ip_ttl, ip_ports, ip_protocols ON ip_statistics.ipAddress=ip_mac.ipAddress AND ip_statistics.ipAddress=ip_ttl.ipAddress AND ip_statistics.ipAddress=ip_ports.ipAddress AND ip_statistics.ipAddress=ip_protocols.ipAddress WHERE ",
  132. "macaddress": "SELECT DISTINCT macAddress from ip_mac WHERE "}
  133. query = named_queries.get(keyword)
  134. field_types = self.get_field_types('ip_mac', 'ip_ttl', 'ip_ports', 'ip_protocols', 'ip_statistics', 'ip_mac')
  135. conditions = []
  136. for key, op, value in param_op_val:
  137. # this makes sure that TEXT fields are queried by strings,
  138. # e.g. ipAddress=192.168.178.1 --is-converted-to--> ipAddress='192.168.178.1'
  139. if field_types.get(key) == 'TEXT':
  140. if not str(value).startswith("'") and not str(value).startswith('"'):
  141. value = "'" + value + "'"
  142. # this replacement is required to remove ambiguity in SQL query
  143. if key == 'ipAddress':
  144. key = 'ip_mac.ipAddress'
  145. conditions.append(key + op + str(value))
  146. where_clause = " AND ".join(conditions)
  147. query += where_clause
  148. self.cursor.execute(query)
  149. return self.cursor.fetchall()
  150. def _process_named_query(self, query_param_list):
  151. """
  152. Executes a named query.
  153. :param query_param_list: A query list consisting of (keyword, params), e.g. [(most_used, ipAddress), (random,)]
  154. :return: the result of the query
  155. """
  156. # Definition of SQL queries associated to named queries
  157. named_queries = {
  158. "most_used.ipaddress": "SELECT ipAddress FROM ip_statistics WHERE (pktsSent+pktsReceived) == (SELECT MAX(pktsSent+pktsReceived) from ip_statistics) ORDER BY ipAddress ASC",
  159. "most_used.macaddress": "SELECT macAddress FROM (SELECT macAddress, COUNT(*) as occ from ip_mac GROUP BY macAddress) WHERE occ=(SELECT COUNT(*) as occ from ip_mac GROUP BY macAddress ORDER BY occ DESC LIMIT 1) ORDER BY macAddress ASC",
  160. "most_used.portnumber": "SELECT portNumber FROM ip_ports GROUP BY portNumber HAVING COUNT(portNumber)=(SELECT MAX(cntPort) from (SELECT portNumber, COUNT(portNumber) as cntPort FROM ip_ports GROUP BY portNumber)) ORDER BY portNumber ASC",
  161. "most_used.protocolname": "SELECT protocolName FROM ip_protocols GROUP BY protocolName HAVING COUNT(protocolCount)=(SELECT COUNT(protocolCount) as cnt FROM ip_protocols GROUP BY protocolName ORDER BY cnt DESC LIMIT 1) ORDER BY protocolName ASC",
  162. "most_used.ttlvalue": "SELECT ttlValue FROM (SELECT ttlValue, SUM(ttlCount) as occ FROM ip_ttl GROUP BY ttlValue) WHERE occ=(SELECT SUM(ttlCount) as occ FROM ip_ttl GROUP BY ttlValue ORDER BY occ DESC LIMIT 1) ORDER BY ttlValue ASC",
  163. "most_used.mssvalue": "SELECT mssValue FROM (SELECT mssValue, SUM(mssCount) as occ FROM tcp_mss GROUP BY mssValue) WHERE occ=(SELECT SUM(mssCount) as occ FROM tcp_mss GROUP BY mssValue ORDER BY occ DESC LIMIT 1) ORDER BY mssValue ASC",
  164. "most_used.winsize": "SELECT winSize FROM (SELECT winSize, SUM(winCount) as occ FROM tcp_win GROUP BY winSize) WHERE occ=(SELECT SUM(winCount) as occ FROM tcp_win GROUP BY winSize ORDER BY occ DESC LIMIT 1) ORDER BY winSize ASC",
  165. "most_used.ipclass": "SELECT ipClass FROM (SELECT ipClass, COUNT(*) as occ from ip_statistics GROUP BY ipClass ORDER BY occ DESC) WHERE occ=(SELECT COUNT(*) as occ from ip_statistics GROUP BY ipClass ORDER BY occ DESC LIMIT 1) ORDER BY ipClass ASC",
  166. #FIXME ORDER BY ASC ? check queries for os dependency!!
  167. "least_used.ipaddress": "SELECT ipAddress FROM ip_statistics WHERE (pktsSent+pktsReceived) == (SELECT MIN(pktsSent+pktsReceived) from ip_statistics) ORDER BY ipAddress ASC",
  168. "least_used.macaddress": "SELECT macAddress FROM (SELECT macAddress, COUNT(*) as occ from ip_mac GROUP BY macAddress) WHERE occ=(SELECT COUNT(*) as occ from ip_mac GROUP BY macAddress ORDER BY occ ASC LIMIT 1) ORDER BY macAddress ASC",
  169. "least_used.portnumber": "SELECT portNumber FROM ip_ports GROUP BY portNumber HAVING COUNT(portNumber)=(SELECT MIN(cntPort) from (SELECT portNumber, COUNT(portNumber) as cntPort FROM ip_ports GROUP BY portNumber)) ORDER BY portNumber ASC",
  170. "least_used.protocolname": "SELECT protocolName FROM ip_protocols GROUP BY protocolName HAVING COUNT(protocolCount)=(SELECT COUNT(protocolCount) as cnt FROM ip_protocols GROUP BY protocolName ORDER BY cnt ASC LIMIT 1) ORDER BY protocolName ASC",
  171. "least_used.ttlvalue": "SELECT ttlValue FROM (SELECT ttlValue, SUM(ttlCount) as occ FROM ip_ttl GROUP BY ttlValue) WHERE occ=(SELECT SUM(ttlCount) as occ FROM ip_ttl GROUP BY ttlValue ORDER BY occ ASC LIMIT 1) ORDER BY ttlValue ASC",
  172. "least_used.mssvalue": "SELECT mssValue FROM (SELECT mssValue, SUM(mssCount) as occ FROM tcp_mss GROUP BY mssValue) WHERE occ=(SELECT SUM(mssCount) as occ FROM tcp_mss GROUP BY mssValue ORDER BY occ ASC LIMIT 1) ORDER BY mssValue ASC",
  173. "least_used.winsize": "SELECT winSize FROM (SELECT winSize, SUM(winCount) as occ FROM tcp_win GROUP BY winSize) WHERE occ=(SELECT SUM(winCount) as occ FROM tcp_win GROUP BY winSize ORDER BY occ ASC LIMIT 1) ORDER BY winSize ASC",
  174. "avg.pktsreceived": "SELECT avg(pktsReceived) from ip_statistics",
  175. "avg.pktssent": "SELECT avg(pktsSent) from ip_statistics",
  176. "avg.kbytesreceived": "SELECT avg(kbytesReceived) from ip_statistics",
  177. "avg.kbytessent": "SELECT avg(kbytesSent) from ip_statistics",
  178. "avg.ttlvalue": "SELECT avg(ttlValue) from ip_ttl",
  179. "avg.mss": "SELECT avg(mssValue) from tcp_mss",
  180. "all.ipaddress": "SELECT ipAddress from ip_statistics ORDER BY ipAddress ASC",
  181. "all.ttlvalue": "SELECT DISTINCT ttlValue from ip_ttl ORDER BY ttlValue ASC",
  182. "all.mss": "SELECT DISTINCT mssValue from tcp_mss ORDER BY mssValue ASC",
  183. "all.macaddress": "SELECT DISTINCT macAddress from ip_mac ORDER BY macAddress ASC",
  184. "all.portnumber": "SELECT DISTINCT portNumber from ip_ports ORDER BY portNumber ASC",
  185. "all.protocolname": "SELECT DISTINCT protocolName from ip_protocols ORDER BY protocolName ASC"}
  186. # Retrieve values by selectors, if given, reduce results by extractor
  187. last_result = 0
  188. for q in query_param_list:
  189. # if selector, like avg, ttl, is given
  190. if any(e in q[0] for e in self._get_selector_keywords()):
  191. (keyword, param) = q
  192. query = named_queries.get(keyword + "." + param)
  193. self.cursor.execute(str(query))
  194. last_result = self.cursor.fetchall()
  195. # if selector is parametrized, i.e. ipAddress(mac=AA:BB:CC:DD:EE) or macAddress(ipAddress=192.168.178.1)
  196. elif any(e in q[0] for e in self._get_parametrized_selector_keywords()) and any(
  197. o in q[1] for o in ["<", "=", ">", "<=", ">="]):
  198. (keyword, param) = q
  199. # convert string 'paramName1<operator1>paramValue1,paramName2<operator2>paramValue2,...' into list of triples
  200. param_op_val = [(key, op, value) for (key, op, value) in
  201. [re.split("(<=|>=|>|<|=)", x) for x in param.split(",")]]
  202. last_result = self.named_query_parameterized(keyword, param_op_val)
  203. # if extractor, like random, first, last, is given
  204. elif any(e in q[0] for e in self._get_extractor_keywords()) and (
  205. isinstance(last_result, list) or isinstance(last_result, tuple)):
  206. extractor = q[0]
  207. if extractor == 'random':
  208. index = randint(a=0, b=len(last_result) - 1)
  209. last_result = last_result[index]
  210. elif extractor == 'first':
  211. last_result = last_result[0]
  212. elif extractor == 'last':
  213. last_result = last_result[-1]
  214. return last_result
  215. def process_db_query(self, query_string_in: str, print_results=False, sql_query_parameters: tuple = None):
  216. """
  217. Processes a database query. This can either be a standard SQL query or a named query (predefined query).
  218. :param query_string_in: The string containing the query
  219. :param print_results: Indicated whether the results should be printed to terminal (True) or not (False)
  220. :param sql_query_parameters: Parameters for the SQL query (optional)
  221. :return: the results of the query
  222. """
  223. named_query_keywords = self.get_all_named_query_keywords()
  224. # Clean query_string
  225. query_string = query_string_in.lower().lstrip()
  226. # query_string is a user-defined SQL query
  227. result = None
  228. if sql_query_parameters is not None or query_string.startswith("select") or query_string.startswith("insert"):
  229. result = self._process_user_defined_query(query_string, sql_query_parameters)
  230. # query string is a named query -> parse it and pass it to statisticsDB
  231. elif any(k in query_string for k in named_query_keywords) and all(k in query_string for k in ['(', ')']):
  232. # Clean query_string
  233. query_string = query_string.replace(" ", "")
  234. # Validity check: Brackets
  235. brackets_open, brackets_closed = query_string.count("("), query_string.count(")")
  236. if not (brackets_open == brackets_closed):
  237. sys.stderr.write("Bracketing of given query '" + query_string + "' is incorrect.")
  238. # Parse query string into [ (query_keyword1, query_params1), ... ]
  239. delimiter_start, delimiter_end = "(", ")"
  240. kplist = []
  241. current_word = ""
  242. for char in query_string: # process characters one-by-one
  243. # if char is no delimiter, add char to current_word
  244. if char != delimiter_end and char != delimiter_start:
  245. current_word += char
  246. # if a start delimiter was found and the current_word so far is a keyword, add it to kplist
  247. elif char == delimiter_start:
  248. if current_word in named_query_keywords:
  249. kplist.append((current_word,))
  250. current_word = ""
  251. else:
  252. print("ERROR: Unrecognized keyword '" + current_word + "' found. Ignoring query.")
  253. return
  254. # else if characeter is end delimiter and there were no two directly following ending delimiters,
  255. # the current_word must be the parameters of an earlier given keyword
  256. elif char == delimiter_end and len(current_word) > 0:
  257. kplist[-1] += (current_word,)
  258. current_word = ""
  259. result = self._process_named_query(kplist[::-1])
  260. else:
  261. sys.stderr.write(
  262. "Query invalid. Only named queries and SQL SELECT/INSERT allowed. Please check the query's syntax!\n")
  263. return
  264. # If result is tuple/list with single element, extract value from list
  265. requires_extraction = (isinstance(result, list) or isinstance(result, tuple)) and len(result) == 1 and \
  266. (not isinstance(result[0], tuple) or len(result[0]) == 1)
  267. while requires_extraction:
  268. if isinstance(result, list) or isinstance(result, tuple):
  269. result = result[0]
  270. else:
  271. requires_extraction = False
  272. # If tuple of tuples or list of tuples, each consisting of single element is returned,
  273. # then convert it into list of values, because the returned colum is clearly specified by the given query
  274. if (isinstance(result, tuple) or isinstance(result, list)) and all(len(val) == 1 for val in result):
  275. result = [c for c in result for c in c]
  276. # Print results if option print_results is True
  277. if print_results:
  278. if isinstance(result, list) and len(result) == 1:
  279. result = result[0]
  280. print("Query returned 1 record:\n")
  281. for i in range(0, len(result)):
  282. print(str(self.cursor.description[i][0]) + ": " + str(result[i]))
  283. else:
  284. self._print_query_results(query_string_in, result)
  285. return result
  286. def _print_query_results(self, query_string_in: str, result):
  287. """
  288. Prints the results of a query.
  289. Based on http://stackoverflow.com/a/20383011/3017719.
  290. :param query_string_in: The query the results belong to
  291. :param result: The results of the query
  292. """
  293. # Print number of results according to type of result
  294. if isinstance(result, list):
  295. print("Query returned " + str(len(result)) + " records:\n")
  296. else:
  297. print("Query returned 1 record:\n")
  298. # Print query results
  299. if query_string_in.lstrip().upper().startswith(
  300. "SELECT") and result is not None and self.cursor.description is not None:
  301. widths = []
  302. columns = []
  303. tavnit = '|'
  304. separator = '+'
  305. for cd in self.cursor.description:
  306. widths.append(len(cd) + 10)
  307. columns.append(cd[0])
  308. for w in widths:
  309. tavnit += " %-" + "%ss |" % (w,)
  310. separator += '-' * w + '--+'
  311. print(separator)
  312. print(tavnit % tuple(columns))
  313. print(separator)
  314. if isinstance(result, list):
  315. for row in result:
  316. print(tavnit % row)
  317. else:
  318. print(tavnit % result)
  319. print(separator)
  320. else:
  321. print(result)