added functionalities, todo and docstrings

Author: nikolasfil

app/ctfsolver/src/ctfsolver.py

@@ -9,17 +9,29 @@ def __init__(self, *args, **kwargs) -> None:
         self.debug = kwargs.get("debug", False)
 
     def initializing_all_ancestors(self, *args, **kwargs):
+        """
+        Description:
+            Initializes all the ancestors of the class
+        """
         ManagerFile.__init__(self, *args, **kwargs)
         ManagerCrypto.__init__(self, *args, **kwargs)
         ManagerConnections.__init__(self, *args, **kwargs)
 
     def main(self):
+        """
+        Description:
+            Placeholder for the main function
+        """
         pass
 
     def __str__(self):
-        return f"CTFSolver({self.parent})"
+        """
+        Description:
+            Returns the string representation of the class, mainly the name of the parent folder
 
-    def __str__(self):
+        Returns:
+            _type_: _description_
+        """
         return f"CTFSolver({self.parent})"
 
 

app/ctfsolver/src/manager_crypto.py

@@ -51,6 +51,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
 

app/ctfsolver/src/manager_file.py

@@ -32,6 +32,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 +45,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 +57,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 +72,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 +90,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 +164,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 +213,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

build/lib/ctfsolver/src/manager_file.py

@@ -26,7 +26,7 @@ def get_parent(self):
 
         self.file_called_frame = inspect.stack()
         self.file_called_path = Path(self.file_called_frame[-1].filename)
-        self.parent = Path(self.file_called_path).parent
+        self.parent = Path(self.file_called_path).parent.resolve()
 
         if self.parent.name in self.folders_name_list:
             self.parent = self.parent.parent

docs/TODO.md

@@ -9,23 +9,23 @@
 ## Functionality
 
 - add a list of files that can be considered part of the challenge for easier approach
-- Change the versioning
 
 ## Publish in pip ?
 
 ## Autoamted solver
 
-- Automate the sphynx api documentation ( perhaps a git precommit )
+- ~Automate the sphynx api documentation ( perhaps a git precommit )~
 
 ## Refactor the bash shortcut
 
 - change the way the bash shortcuts are called
 - find a way to add bash autocompletion to the venv
 
-## Script running
-
-- add functionality to figure out where the payloads folder is
-
 ## Documentation
 
 Add the documentation on the commands to run and how the whole package is meant to be used
+
+## Discerning libraries
+
+- Transfer all the pcap files to a different class and just inher it
+- add a template for every other library used for the solver