atomicshop 2.15.11__py3-none-any.whl → 3.10.5__py3-none-any.whl

atomicshop/mitm/engines/__reference_general/requester___reference_general.py

@@ -0,0 +1,47 @@
+# These are specified with hardcoded paths instead of relative, because 'create_module_template.py' copies the content.
+from atomicshop.mitm.engines.__parent.requester___parent import RequesterParent
+from atomicshop.mitm.shared_functions import create_custom_logger
+from atomicshop.mitm.message import ClientMessage
+from atomicshop.mitm import config_static
+
+"""
+import time
+datetime
+import binascii
+
+# This is 'example' '.proto' file that contains message 'ExampleResponse'.
+from .example_pb2 import ExampleRequest
+# Import from 'protobuf' the 'json_format' library.
+from google.protobuf import json_format
+"""
+
+
+class RequesterGeneral(RequesterParent):
+    """The class that is responsible for generating request to client based on the received message."""
+    # When initializing main classes through "super" you need to pass parameters to init
+    def __init__(self):
+        super().__init__()
+
+        self.logger = create_custom_logger()
+
+    # def create_request(self, class_client_message: ClientMessage, **kwargs) -> bytes:
+    #     # noinspection GrazieInspection
+    #     """
+    #     For more examples check the responder.
+    #     Function to create Response based on ClientMessage and its Request.
+    #
+    #     :param class_client_message: contains request and other parameters to help creating response.
+    #     :return: 1 request in byte string.
+    #     -----------------------------------
+    #
+    #     # Example of creating byte string using 'build_byte_request' function:
+    #     request_bytes: bytes = self.build_byte_request(
+    #         http_method=class_client_message.request_raw_decoded.command,
+    #         endpoint=class_client_message.request_raw_decoded.path,
+    #             http_version=class_client_message.request_raw_decoded.request_version,
+    #             headers=response_headers,
+    #             body=b''
+    #     )
+    #
+    #     return request_bytes
+    #     -----------------------------------

atomicshop/mitm/engines/__reference_general/responder___reference_general.py

@@ -1,6 +1,8 @@
 # These are specified with hardcoded paths instead of relative, because 'create_module_template.py' copies the content.
 from atomicshop.mitm.engines.__parent.responder___parent import ResponderParent
 from atomicshop.mitm.shared_functions import create_custom_logger
+from atomicshop.mitm.message import ClientMessage
+from atomicshop.mitm import config_static
 
 """
 import time
@@ -14,14 +16,71 @@ from google.protobuf import json_format
 """
 
 
-# The class that is responsible for generating response to client based on the received message.
 class ResponderGeneral(ResponderParent):
-    logger = create_custom_logger()
-
+    """The class that is responsible for generating response to client based on the received message."""
     # When initializing main classes through "super" you need to pass parameters to init
     def __init__(self):
         super().__init__()
 
+        self.logger = create_custom_logger()
+
+    # def create_response(self, class_client_message: ClientMessage):
+    #     # noinspection GrazieInspection
+    #     """
+    #     Function to create Response based on ClientMessage and its Request.
+    #
+    #     :param class_client_message: contains request and other parameters to help creating response.
+    #     :return: list of responses in bytes.
+    #     -----------------------------------
+    #
+    #     # Example of creating list of bytes using 'build_byte_response' function:
+    #     result_list: list[bytes] = list()
+    #     result_list.append(
+    #         self.build_byte_response(
+    #             http_version=class_client_message.request_raw_decoded.request_version,
+    #             status_code=200,
+    #             headers=response_headers,
+    #             body=b''
+    #         )
+    #     )
+    #
+    #     return result_list
+    #     -----------------------------------
+    #     # Example of extracting variables from URL PATH based on custom PATH TEMPLATE:
+    #     # (more examples in 'self.extract_variables_from_path_template' function description)
+    #     template_path: str = "/hithere/<variable1>/else/<variable2>/tested/"
+    #     path_variables: dict = extract_variables_from_path_template(
+    #         path=class_client_message.request_raw_decoded.path,
+    #         template_path=template_path
+    #     )
+    #     -----------------------------------
+    #     # Example of extracting value from URL PATH parameters after question mark:
+    #     parameter_value = extract_value_from_path_parameter(
+    #         path=class_client_message.request_raw_decoded.path,
+    #         parameter='test_id'
+    #     )
+    #     """
+    #
+    #     # byte_response: bytes = b''
+    #     # self.logger.info(f"Response: {byte_response}")
+    #
+    #     response_bytes_list: list[bytes] = list()
+    #     # response_bytes_list.append(byte_response)
+    #     return response_bytes_list
+
+    # def create_connect_response(self, class_client_message: ClientMessage):
+    #     """
+    #     This is almost the same as 'create_response' function, but it's used only when the client connects and before
+    #     sending any data.
+    #     """
+    #
+    #     # byte_response: bytes = b''
+    #     # self.logger.info(f"Response: {byte_response}")
+    #
+    #     response_bytes_list: list[bytes] = list()
+    #     # response_bytes_list.append(byte_response)
+    #     return response_bytes_list
+
     # ==================================================================================================================
     # Uncomment this section in order to begin building custom responder.
     # @staticmethod
@@ -89,7 +148,7 @@ class ResponderGeneral(ResponderParent):
     #     # === Building Headers. ===========================
     #     # Response Date example: 'Tue, 08 Nov 2022 14:23: 00 GMT'
     #     resp_headers = {
-    #         'Date': self.get_current_formatted_time(),
+    #         'Date': self.get_current_formatted_time_http(),
     #         'Content-Length': str(len(resp_body)),
     #     }
     #
@@ -109,7 +168,7 @@ class ResponderGeneral(ResponderParent):
     #     # === Building Headers. ===========================
     #     # Response Date example: 'Tue, 08 Nov 2022 14:23: 00 GMT'
     #     resp_headers = {
-    #         'Date': self.get_current_formatted_time(),
+    #         'Date': self.get_current_formatted_time_http(),
     #         'Content-Length': str(len(resp_body)),
     #         'Connection': 'keep-alive'
     #     }
@@ -118,10 +177,10 @@ class ResponderGeneral(ResponderParent):
     #
     # def create_response(self, class_client_message: ClientMessage):
     #     # Arranging important request entries to appropriate variables.
-    #     req_path = class_client_message.request_raw_decoded.path
-    #     req_command = class_client_message.request_raw_decoded.command
-    #     req_headers = class_client_message.request_raw_decoded.headers
-    #     req_body = class_client_message.request_raw_decoded.body
+    #     req_path = class_client_message.request_auto_parsed.path
+    #     req_command = class_client_message.request_auto_parsed.command
+    #     req_headers = class_client_message.request_auto_parsed.headers
+    #     req_body = class_client_message.request_auto_parsed.body
     #
     #     # ====================================
     #     # Case specific.
@@ -144,10 +203,33 @@ class ResponderGeneral(ResponderParent):
     #
     #     # ==============================================================================
     #     # === Building byte response. ==================================================
-    #     self.build_byte_response(
-    #         http_version=class_client_message.request_raw_decoded.request_version,
+    #     byte_response = self.build_byte_response(
+    #         http_version=class_client_message.request_auto_parsed.request_version,
     #         status_code=resp_status_code,
     #         headers=resp_headers,
-    #         body=resp_body_bytes,
-    #         client_message=class_client_message
+    #         body=resp_body_bytes
     #     )
+    #
+    #     result_response_list: list[bytes] = [byte_response]
+    #     return result_response_list
+    #
+    # ==================================================================================================================
+    # TEST RESPONSE.
+    # def create_response(self, class_client_message: ClientMessage):
+    #     resp_body_text: bytes = b"<html><body>TEST OK!</body></html>\n"
+    #     resp_status_code: int = 200
+    #     resp_headers: dict = {
+    #         # Tell the browser it’s plain text (could be “text/html” if you wrap it in HTML).
+    #         "Content-Type": "text/html; charset=utf-8"}
+    #
+    #     # Build the raw bytes to send.
+    #     byte_response = self.build_byte_response(
+    #         http_version="HTTP/1.1",
+    #         status_code=resp_status_code,
+    #         headers=resp_headers,
+    #         body=resp_body_text
+    #
+    #     )
+    #
+    #     result_response_list: list[bytes] = [byte_response]
+    #     return result_response_list

atomicshop/mitm/engines/create_module_template.py

@@ -1,8 +1,14 @@
+import sys
 import os
+import argparse
 from typing import Literal
 
-from ... import filesystem
+from ... import filesystem, consoles
 from ...basics import strings
+from rich.console import Console
+
+
+console = Console()
 
 
 GENERAL_CLASS_NAME: str = "General"
@@ -13,6 +19,7 @@ CONFIG_FILE_NAME: str = "engine_config.toml"
 
 REFERENCE_PARSER_FILE_NAME: str = f"parser_{REFERENCE_ENGINE_NAME}.py"
 REFERENCE_RESPONDER_FILE_NAME: str = f"responder_{REFERENCE_ENGINE_NAME}.py"
+REFERENCE_REQUESTER_FILE_NAME: str = f"requester_{REFERENCE_ENGINE_NAME}.py"
 REFERENCE_RECORDER_FILE_NAME: str = f"recorder_{REFERENCE_ENGINE_NAME}.py"
 
 SCRIPT_DIRECTORY: str = filesystem.get_file_directory(__file__)
@@ -20,10 +27,13 @@ ENGINES_DIRECTORY_PATH: str = filesystem.get_working_directory() + os.sep + ENGI
 
 
 class CreateModuleTemplate:
-    def __init__(self, engine_name: str, domains: list):
+    def __init__(
+            self,
+            engine_name: str = None
+    ):
         # === Get input variables. ===
         self.engine_name: str = engine_name
-        self.domains: list = domains
+        self.domains: list = ['example.com:443', 'example.org:80']
 
         # New engine's directory.
         self.new_engine_directory: str = ENGINES_DIRECTORY_PATH + os.sep + self.engine_name
@@ -36,11 +46,13 @@ class CreateModuleTemplate:
         reference_folder_path: str = SCRIPT_DIRECTORY + os.sep + REFERENCE_ENGINE_NAME
         self.parser_general_path: str = reference_folder_path + os.sep + REFERENCE_PARSER_FILE_NAME
         self.responder_general_path: str = reference_folder_path + os.sep + REFERENCE_RESPONDER_FILE_NAME
+        self.requester_general_path: str = reference_folder_path + os.sep + REFERENCE_REQUESTER_FILE_NAME
         self.recorder_general_path: str = reference_folder_path + os.sep + REFERENCE_RECORDER_FILE_NAME
 
-        self.parser_file_name: str = f"parser_{self.engine_name}.py"
-        self.responder_file_name: str = f"responder_{self.engine_name}.py"
-        self.recorder_file_name: str = f"recorder_{self.engine_name}.py"
+        self.parser_file_name: str = f"parser.py"
+        self.responder_file_name: str = f"responder.py"
+        self.requester_file_name: str = f"requester.py"
+        self.recorder_file_name: str = f"recorder.py"
 
         self.create_template()
 
@@ -51,11 +63,12 @@ class CreateModuleTemplate:
         # Create the 'engines' directory if it doesn't exist.
         filesystem.create_directory(ENGINES_DIRECTORY_PATH)
 
-        # Create new engines folder.
+        # Create new engines' folder.
         filesystem.create_directory(self.new_engine_directory)
 
         self._create_engine_module_from_reference(file_path=self.parser_general_path, module_type='parser')
         self._create_engine_module_from_reference(file_path=self.responder_general_path, module_type='responder')
+        self._create_engine_module_from_reference(file_path=self.requester_general_path, module_type='requester')
         self._create_engine_module_from_reference(file_path=self.recorder_general_path, module_type='recorder')
 
         self.create_config_file()
@@ -66,35 +79,42 @@ class CreateModuleTemplate:
 
         # Add "" to each domain.
         domains_with_quotes: list = [f'"{domain}"' for domain in self.domains]
+
+        config_lines_list.append('[engine]')
         config_lines_list.append(f'domains = [{", ".join(domains_with_quotes)}]\n')
-        config_lines_list.append(f'parser_file = "{self.parser_file_name}"')
-        config_lines_list.append(f'responder_file = "{self.responder_file_name}"')
-        config_lines_list.append(f'recorder_file = "{self.recorder_file_name}"')
+        config_lines_list.append('[on_port_connect]')
+        config_lines_list.append('#5000 = "31.31.31.31:443"')
+        config_lines_list.append('#5000 = "ip_port_address.txt"\n')
+        config_lines_list.append('[mtls]')
+        config_lines_list.append('# "subdomain.domain.com" = "file_name_in_current_dir.pem"\n')
+        # config_lines_list.append(f'\n')
 
         config_file_path = self.new_engine_directory + os.sep + CONFIG_FILE_NAME
 
         with open(config_file_path, 'w') as output_file:
             output_file.write('\n'.join(config_lines_list))
 
-        print(f"Config File Created: {config_file_path}")
+        console.print(f"Config File Created: {config_file_path}", style="bright_blue")
 
     def _create_engine_module_from_reference(
             self,
             file_path: str,
-            module_type: Literal['parser', 'responder', 'recorder']
+            module_type: Literal['parser', 'responder', 'requester', 'recorder']
     ):
 
         if module_type == 'parser':
             new_module_file_name = self.parser_file_name
         elif module_type == 'responder':
             new_module_file_name = self.responder_file_name
+        elif module_type == 'requester':
+            new_module_file_name = self.requester_file_name
         elif module_type == 'recorder':
             new_module_file_name = self.recorder_file_name
         else:
             raise ValueError(f"Module type is not recognized: {module_type}")
 
         # Reading the module file to string.
-        with open(file_path, 'r') as input_file:
+        with open(file_path, 'r', encoding='utf-8') as input_file:
             file_content_string = input_file.read()
 
         new_module_full_path: str = str()
@@ -107,4 +127,28 @@ class CreateModuleTemplate:
                 output_file.write(new_content_string)
 
         print(f"Converted: {file_path}")
-        print(f"To: {new_module_full_path}")
+        console.print(f"To: {new_module_full_path}", style="green")
+
+
+def create_template(engine_name: str) -> int:
+    CreateModuleTemplate(engine_name=engine_name)
+    return 0
+
+
+def _make_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(description='Create a new engine module template.')
+    parser.add_argument('engine_name', type=str, help='The name of the new engine.')
+    return parser
+
+
+def main() -> int:
+    arg_parser: argparse.ArgumentParser = _make_parser()
+    args = arg_parser.parse_args()
+
+    rc: int = create_template(**vars(args))
+    consoles.wait_any_key()
+    return rc
+
+
+if __name__ == '__main__':
+    sys.exit(main())