working on splitting the libraries

Author: nikolasfil

VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

app/ctfsolver.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ctfsolver
-Version: 0.0.5
+Version: 0.0.7
 Summary: An all in one library for solving CTF challenges
 Home-page: https://github.com/nikolasfil/CTFSolverScript
 Author: Nikolas Filippatos

app/ctfsolver.egg-info/SOURCES.txt

@@ -25,6 +25,7 @@ app/ctfsolver/src/ctfsolver.py
 app/ctfsolver/src/manager_connections.py
 app/ctfsolver/src/manager_crypto.py
 app/ctfsolver/src/manager_file.py
+app/ctfsolver/src/manager_files_pcap.py
 app/ctfsolver/template/__init__.py
 app/ctfsolver/template/__main__.py
 app/ctfsolver/template/solution_template.py

app/ctfsolver/src/manager_crypto.py

@@ -6,7 +6,15 @@ class ManagerCrypto:
     def __init__(self, *args, **kwargs) -> None:
         pass
 
-    def xor(self, text, key):
+    def initializing_all_ancestors(self, *args, **kwargs):
+        """
+        Description:
+            Initializes all the ancestors of the class
+
+        """
+        pass
+
+    def xor(self, text: str, key: str) -> str:
         """
         Description:
         XOR the text with the key
@@ -37,34 +45,7 @@ def decode_base64(self, text):
             print(e)
             return None
 
-    def searching_text_in_packets(self, text, packets=None, display=False):
-        """
-        Description:
-        Search for a text in the packets that have been opened with scapy
-
-        Args:
-            text (str): Text to search in the packets
-            packets (list, optional): List of packets to search in. Defaults to None.
-            display (bool, optional): Display the packet if the text is found. Defaults to False.
-
-        Returns:
-            str: Text found in the packet if found
-        """
-
-        # Todo : Transfer into a different class that will be mainly for packet analysis
-        if not packets:
-            packets = self.packets
-
-        for i, packet in enumerate(packets):
-            if packet.haslayer("Raw"):
-                if text.encode() in packet["Raw"].load:
-                    if display:
-                        print(f"Found {text} in packet {i}")
-                        print(packet.show())
-                        print(packet.summary())
-                    return packet["Raw"].load.decode("utf-8")
-
-    def re_match_base64_string(self, text, strict=False):
+    def re_match_base64_string(self, text: str, strict=False) -> list[str]:
         """
         Description:
         Find the base64 string in the text
@@ -83,7 +64,7 @@ def re_match_base64_string(self, text, strict=False):
         base64_strings = re.findall(base64_pattern, text)
         return base64_strings
 
-    def re_match_flag(self, text, origin):
+    def re_match_flag(self, text: str, origin: str) -> list[str]:
         """
         Description:
         Find the flag in the text
@@ -98,7 +79,7 @@ def re_match_flag(self, text, origin):
         flag_pattern = rf"{origin}{{[A-Za-z0-9_]+}}"
         return re.findall(flag_pattern, text)
 
-    def re_match_partial_flag(self, text, origin):
+    def re_match_partial_flag(self, text: str, origin: str) -> list[str]:
         """
         Description:
         Find the flag in the text or partial flag

app/ctfsolver/src/manager_file.py

@@ -1,11 +1,11 @@
 from pathlib import Path
 import inspect
-from scapy.all import rdpcap
 import os
 import ast
+from .manager_files_pcap import ManagerFilePcap
 
 
-class ManagerFile:
+class ManagerFile(ManagerFilePcap):
     def __init__(self, *args, **kwargs):
         self.Path = Path
         self.file = kwargs.get("file")
@@ -17,6 +17,13 @@ def __init__(self, *args, **kwargs):
         self.setup_named_folders()
         self.get_challenge_file()
 
+    def initializing_all_ancestors(self, *args, **kwargs):
+        """
+        Description:
+            Initializes all the ancestors of the class
+        """
+        ManagerFilePcap.__init__(self, *args, **kwargs)
+
     def get_parent(self):
         """
         Description:
@@ -159,18 +166,6 @@ def exec_on_files(self, folder, func, *args, **kwargs):
         if save:
             return output
 
-    def pcap_open(self, file=None):
-        """
-        Description:
-        Open the pcap file with scapy and saves it in self.packets
-        """
-        # Todo : Transfer into a different class that will be mainly for packet analysis
-
-        if not file:
-            file = self.challenge_file
-
-        self.packets = rdpcap(file.as_posix())
-
     def search_files(
         self, directory, exclude_dirs, search_string, save=False, display=False
     ):

app/ctfsolver/src/manager_files_pcap.py

@@ -0,0 +1,61 @@
+from pathlib import Path
+import inspect
+from scapy.all import rdpcap
+import os
+import ast
+
+
+class ManagerFilePcap:
+    def __init__(self, *args, **kwargs):
+        pass
+
+    def initializing_all_ancestors(self, *args, **kwargs):
+        """
+        Description:
+            Initializes all the ancestors of the class
+        """
+
+    def pcap_open(self, file=None, save=False):
+        """
+        Description:
+            Open the pcap file with scapy and saves it in self.packets
+
+        Args:
+            file (Path, optional): File to open. Defaults to None.
+            save (bool, optional): Save the output. Defaults to False.
+
+        """
+
+        if file is None:
+            file = self.challenge_file
+
+        self.packets = rdpcap(file.as_posix())
+
+        if save:
+            return self.packets
+
+    def searching_text_in_packets(self, text, packets=None, display=False):
+        """
+        Description:
+        Search for a text in the packets that have been opened with scapy
+
+        Args:
+            text (str): Text to search in the packets
+            packets (list, optional): List of packets to search in. Defaults to None.
+            display (bool, optional): Display the packet if the text is found. Defaults to False.
+
+        Returns:
+            str: Text found in the packet if found
+        """
+
+        if packets is None:
+            packets = self.packets
+
+        for i, packet in enumerate(packets):
+            if packet.haslayer("Raw"):
+                if text.encode() in packet["Raw"].load:
+                    if display:
+                        print(f"Found {text} in packet {i}")
+                        print(packet.show())
+                        print(packet.summary())
+                    return packet["Raw"].load.decode("utf-8")

build/lib/ctfsolver/src/manager_crypto.py

@@ -6,7 +6,15 @@ class ManagerCrypto:
     def __init__(self, *args, **kwargs) -> None:
         pass
 
-    def xor(self, text, key):
+    def initializing_all_ancestors(self, *args, **kwargs):
+        """
+        Description:
+            Initializes all the ancestors of the class
+
+        """
+        pass
+
+    def xor(self, text: str, key: str) -> str:
         """
         Description:
         XOR the text with the key
@@ -51,6 +59,7 @@ def searching_text_in_packets(self, text, packets=None, display=False):
             str: Text found in the packet if found
         """
 
+        # Todo : Transfer into a different class that will be mainly for packet analysis
         if not packets:
             packets = self.packets
 
@@ -63,7 +72,7 @@ def searching_text_in_packets(self, text, packets=None, display=False):
                         print(packet.summary())
                     return packet["Raw"].load.decode("utf-8")
 
-    def re_match_base64_string(self, text, strict=False):
+    def re_match_base64_string(self, text: str, strict=False) -> list[str]:
         """
         Description:
         Find the base64 string in the text
@@ -82,7 +91,7 @@ def re_match_base64_string(self, text, strict=False):
         base64_strings = re.findall(base64_pattern, text)
         return base64_strings
 
-    def re_match_flag(self, text, origin):
+    def re_match_flag(self, text: str, origin: str) -> list[str]:
         """
         Description:
         Find the flag in the text
@@ -97,7 +106,7 @@ def re_match_flag(self, text, origin):
         flag_pattern = rf"{origin}{{[A-Za-z0-9_]+}}"
         return re.findall(flag_pattern, text)
 
-    def re_match_partial_flag(self, text, origin):
+    def re_match_partial_flag(self, text: str, origin: str) -> list[str]:
         """
         Description:
         Find the flag in the text or partial flag

build/lib/ctfsolver/src/manager_file.py

@@ -3,9 +3,10 @@
 from scapy.all import rdpcap
 import os
 import ast
+from .manager_files_pcap import ManagerFilePcap
 
 
-class ManagerFile:
+class ManagerFile(ManagerFilePcap):
     def __init__(self, *args, **kwargs):
         self.Path = Path
         self.file = kwargs.get("file")
@@ -17,6 +18,13 @@ def __init__(self, *args, **kwargs):
         self.setup_named_folders()
         self.get_challenge_file()
 
+    def initializing_all_ancestors(self, *args, **kwargs):
+        """
+        Description:
+            Initializes all the ancestors of the class
+        """
+        ManagerFilePcap.__init__(self, *args, **kwargs)
+
     def get_parent(self):
         """
         Description:
@@ -32,6 +40,10 @@ def get_parent(self):
             self.parent = self.parent.parent
 
     def setup_named_folder_list(self):
+        """
+        Description:
+        Setup the main named folder list. If the user has provided a list, add the must folders to it
+        """
         if self.folders_name_list is None:
             self.folders_name_list = self.folders_names_must
         elif len(self.folders_name_list) > 1:
@@ -41,7 +53,7 @@ def setup_named_folder_list(self):
     def setup_named_folders(self):
         """
         Description:
-        Create folders for the challenge
+        Create folders for the challenge. (data, files, payloads)
         """
 
         self.folder_payloads = None
@@ -53,7 +65,10 @@ def setup_named_folders(self):
         self.folder_payloads = Path(self.parent, "payloads")
 
     def create_parent_folder(self):
-        """ """
+        """
+        Description:
+            Create the parent folder of the file that called the class if they don't exist
+        """
 
         self.folder_data = Path(self.parent, "data")
         self.folder_files = Path(self.parent, "files")
@@ -65,17 +80,14 @@ def create_parent_folder(self):
             self.folder_files,
         ]
 
-        # add the folders that are in the named_list but are not in the folder_list
-        # Make the folder_list public
-
         for folder in folder_list:
             if not folder.exists():
                 folder.mkdir()
 
     def prepare_space(self, files=None, folder=None, test_text="picoCTF{test}"):
         """
         Description:
-        Prepare the space for the challenge by creating the folders if they don't exist
+           Prepare the space for the challenge by creating the folders if they don't exist, create files from the file list provided
         """
         files = files if files else []
         folder = folder if folder else self.folder_files
@@ -86,9 +98,13 @@ def prepare_space(self, files=None, folder=None, test_text="picoCTF{test}"):
                     f.write(test_text)
 
     def get_challenge_file(self):
-        if self.file and self.folder_data:
+        """
+        Description:
+            Get the challenge file and assign it to the self.challenge_file for ease of access
+        """
+        if self.file and self.folder_files:
             self.challenge_file = Path(self.folder_files, self.file)
-        elif not self.folder_data:
+        elif not self.folder_files:
             if self.debug:
                 print("Data folder not found")
 
@@ -156,6 +172,7 @@ def pcap_open(self, file=None):
         Description:
         Open the pcap file with scapy and saves it in self.packets
         """
+        # Todo : Transfer into a different class that will be mainly for packet analysis
 
         if not file:
             file = self.challenge_file
@@ -204,6 +221,12 @@ def search_files(
             return output
 
     def search_for_base64(self, file, *args, **kwargs):
+        """
+        Depracated, checkout search_for_base64_file
+        """
+        return self.search_for_base64_file(file, *args, **kwargs)
+
+    def search_for_base64_file(self, file, *args, **kwargs):
         """
         Description:
         Search for base64 string in the file