Session - Hybrid DB

mitmproxy/addons/session.py

@@ -0,0 +1,59 @@
+import os
+import sqlite3
+
+from mitmproxy.exceptions import SessionLoadException
+from mitmproxy.utils.data import pkg_data
+
+
+# Could be implemented using async libraries
+class SessionDB:
+    """
+    This class wraps connection to DB
+    for Sessions and handles creation,
+    retrieving and insertion in tables.
+    """
+
+    def __init__(self, db_path=None):
+        """
+        Connect to an already existing database,
+        or create a new one with optional path.
+        :param db_path:
+        """
+        if db_path is not None and os.path.isfile(db_path):
+            self._load_session(db_path)
+        else:
+            path = db_path or 'tmp.sqlite'
+            # in case tmp.sqlite already exists in FS
+            if os.path.isfile(path):
+                os.remove(path)
+            self.con = sqlite3.connect(path)
+            script_path = pkg_data.path("io/sql/session_create.sql")
+            qry = open(script_path, 'r').read()
+            with self.con:
+                self.con.executescript(qry)
+
+    def _load_session(self, path):
+        if not self.is_session_db(path):
+            raise SessionLoadException('Given path does not point to a valid Session')
+        self.con = sqlite3.connect(path)
+
+    @staticmethod
+    def is_session_db(path):
+        """
+        Check if database entered from user
+        is a valid Session SQLite DB.
+        :return: True if valid, False if invalid.
+        """
+        try:
+            c = sqlite3.connect(f'file:{path}?mode=rw', uri=True)
+            cursor = c.cursor()
+            cursor.execute("SELECT NAME FROM sqlite_master WHERE type='table';")
+            rows = cursor.fetchall()
+            tables = [('FLOW',), ('BODY',), ('META',), ('ANNOTATION',)]
+            if all(elem in rows for elem in tables):
+                c.close()
+                return True
+        except:
+            if c:
+                c.close()
+        return False

mitmproxy/exceptions.py

@@ -129,6 +129,10 @@ def __init__(self, message=None):
         super().__init__(message)
 
 
+class SessionLoadException(MitmproxyException):
+    pass
+
+
 class Disconnect:
     """Immediate EOF"""
 

mitmproxy/io/sql/session_create.sql

@@ -0,0 +1,26 @@
+CREATE TABLE FLOW (
+FID INTEGER PRIMARY KEY,
+MID INTEGER,
+BID INTEGER,
+CONTENT BLOB
+);
+
+CREATE TABLE META (
+MID INTEGER PRIMARY KEY,
+INTERCEPTED INTEGER,
+MARKED INTEGER,
+MODE VARCHAR(20)
+);
+
+CREATE TABLE BODY (
+BID INTEGER,
+BREQ BLOB,
+BRES BLOB
+);
+
+CREATE TABLE ANNOTATION (
+AID INTEGER PRIMARY KEY,
+FID INTEGER,
+TYPE VARCHAR(20),
+CONTENT BLOB
+);

test/mitmproxy/addons/test_session.py

@@ -0,0 +1,52 @@
+import sqlite3
+import os
+import pytest
+
+from mitmproxy.exceptions import SessionLoadException
+from mitmproxy.addons import session
+from mitmproxy.utils.data import pkg_data
+
+
+class TestSession:
+    def test_session_temporary(self, tdata):
+        open('tmp.sqlite', 'w')
+        s = session.SessionDB()
+        assert session.SessionDB.is_session_db('tmp.sqlite')
+        s.con.close()
+        os.remove('tmp.sqlite')
+
+    def test_session_not_valid(self, tdata):
+        path = tdata.path('mitmproxy/data/') + '/test.sqlite'
+        if os.path.isfile(path):
+            os.remove(path)
+        with open(path, 'w') as handle:
+            handle.write("Not valid data")
+        with pytest.raises(SessionLoadException):
+            session.SessionDB(path)
+
+    def test_session_new_persistent(self, tdata):
+        path = tdata.path('mitmproxy/data/') + '/test.sqlite'
+        if os.path.isfile(path):
+            os.remove(path)
+        session.SessionDB(path)
+        assert session.SessionDB.is_session_db(path)
+
+    def test_session_load_existing(self, tdata):
+        path = tdata.path('mitmproxy/data/') + '/test.sqlite'
+        if os.path.isfile(path):
+            os.remove(path)
+        con = sqlite3.connect(path)
+        script_path = pkg_data.path("io/sql/session_create.sql")
+        qry = open(script_path, 'r').read()
+        with con:
+            con.executescript(qry)
+            blob = b'blob_of_data'
+            con.execute(f'INSERT INTO FLOW VALUES(1, 1, 1, "{blob}");')
+        con.close()
+        session.SessionDB(path)
+        con = sqlite3.connect(path)
+        with con:
+            cur = con.cursor()
+            cur.execute('SELECT * FROM FLOW;')
+            rows = cur.fetchall()
+            assert len(rows) == 1