atomicshop 3.0.2__py3-none-any.whl → 3.1.0__py3-none-any.whl

atomicshop/__init__.py

@@ -1,4 +1,4 @@
 """Atomic Basic functions and classes to make developer life easier"""
 
 __author__ = "Den Kras"
-__version__ = '3.0.2'
+__version__ = '3.1.0'

atomicshop/mitm/connection_thread_worker.py

@@ -180,16 +180,22 @@ def thread_worker_main(
 
         network_logger.info("Thread Finished. Will continue listening on the Main thread")
 
+    def create_requester_request(client_message: ClientMessage) -> list[bytes]:
+        requests: list = [requester.create_response(client_message)]
+
+        # Output first 100 characters of all the requests in the list.
+        for request_raw_bytes_single in requests:
+            requester.logger.info(f"{request_raw_bytes_single[0: 100]}...")
+
+        return requests
+
     def create_responder_response(client_message: ClientMessage) -> list[bytes]:
         if client_message.action == 'service_connect':
             return responder.create_connect_response(client_message)
         else:
-            # Since we're in response mode, we'll record the request anyway, after the responder did its job.
-            # client_message.info = "In Server Response Mode"
-
-            # If it's the first cycle and the protocol is Websocket, then we'll create the HTTP Handshake
+            # If we're in offline mode, and it's the first cycle and the protocol is Websocket, then we'll create the HTTP Handshake
             # response automatically.
-            if protocol == 'Websocket' and client_receive_count == 1:
+            if config_static.MainConfig.offline and protocol == 'Websocket' and client_receive_count == 1:
                 responses: list = list()
                 responses.append(
                     websocket_parse.create_byte_http_response(client_message.request_raw_bytes))
@@ -380,12 +386,14 @@ def thread_worker_main(
                     # Now send it to requester/responder.
                     if side == 'Client':
                         # Send to requester.
-                        bytes_to_send_list: list[bytes] = [client_message.request_raw_bytes]
-                    else:
+                        bytes_to_send_list: list[bytes] = create_requester_request(client_message)
+                    elif side == 'Service':
                         bytes_to_send_list: list[bytes] = create_responder_response(client_message)
                         print_api(f"Got responses from responder, count: [{len(bytes_to_send_list)}]",
                                   logger=network_logger,
                                   logger_method='info')
+                    else:
+                        raise ValueError(f"Unknown side [{side}] of the socket: {receiving_socket}")
 
                     if is_socket_closed:
                         exception_or_close_in_receiving_thread = True
@@ -511,15 +519,16 @@ def thread_worker_main(
         reference_module=reference_module
     )
     parser = found_domain_module.parser_class_object
+    requester = found_domain_module.requester_class_object()
     responder = found_domain_module.responder_class_object()
     recorder = found_domain_module.recorder_class_object(record_path=config_static.LogRec.recordings_path)
 
     network_logger.info(f"Assigned Modules for [{server_name}]: "
         f"{parser.__name__}, "
+        f"{requester.__class__.__name__}, "
         f"{responder.__class__.__name__}, "
         f"{recorder.__class__.__name__}")
 
-
     # Initializing the client message object with current thread's data.
     # This is needed only to skip error alerts after 'try'.
     client_message_connection: ClientMessage = ClientMessage()

atomicshop/mitm/engines/__parent/requester___parent.py

@@ -0,0 +1,116 @@
+# Using to convert status code to status phrase / string.
+from http import HTTPStatus
+# Parsing PATH template to variables.
+from pathlib import PurePosixPath
+from urllib.parse import unquote
+# Needed to extract parameters after question mark in URL / Path.
+from urllib.parse import urlparse
+from urllib.parse import parse_qs
+
+from ...message import ClientMessage
+from .... import http_parse
+from ....print_api import print_api
+
+from atomicshop.mitm.shared_functions import create_custom_logger
+
+
+class RequesterParent:
+    """The class that is responsible for generating request to client based on the received message."""
+    def __init__(self):
+        self.logger = create_custom_logger()
+
+    def build_byte_request(
+            self,
+            http_method: str,
+            endpoint: str,
+            http_version: str,
+            headers: dict,
+            body: bytes
+    ) -> bytes:
+        # noinspection GrazieInspection
+        """
+                Create genuine request from input parameters.
+                ---------------
+                The request is built from:
+                <http_method> <endpoint> <http_version>\r\n
+                Headers1: Value\r\n
+                Headers2: Value\r\n
+                \r\n                        # This is meant to end the headers' section
+                Body                        # Request doesn't end with '\r\n\r\n'
+                ---------------
+                Example for POST request:
+                POST /api/v1/resource HTTP/1.1\r\n
+                Cache-Control: max-age=86400\r\n
+                Content-Type: application/json; charset=utf-8\r\n
+                \r\n
+                {"id":1,"name":"something"}
+                ---------------
+                You can create response as:
+
+                ...POST endpoint/api/1 HTTP/1.1
+                header1: value
+                header2: value
+
+                {data: value}...
+
+                Change 3 dots ("...") to 3 double quotes before "POST" and after "value}".
+                This way there will be "\n" added automatically after each line.
+                While, the HTTP Client does the parsing of the text and not raw data, most probably it will be parsed well,
+                but genuine requests from HTTP sources come with "\r\n" at the end of the line, so better use these for
+                better compatibility.
+                ---------------
+
+                :param http_method: HTTP Method of Request, e.g. 'GET', 'POST', etc.
+                :param endpoint: Endpoint of Request, e.g. '/api/v1/resource'.
+                :param http_version: HTTP Version of Response in HTTP Status line.
+                :param headers: HTTP Headers of Response.
+                :param body: HTTP body data of Response, bytes.
+                :return: bytes of the response.
+                """
+
+        try:
+            # CHeck if the HTTP method is valid.
+            if http_method not in http_parse.get_request_methods():
+                raise ValueError(f"Invalid HTTP Method: {http_method}")
+
+            # Building the full method endpoint string line and the "\r\n" in the end.
+            method_full: str = f"{http_method} {endpoint} {http_version}\r\n"
+
+            # Defining headers string.
+            headers_string: str = str()
+            # Adding all the headers to the full response
+            for keys, values in headers.items():
+                headers_string = headers_string + str(keys) + ": " + str(values) + "\r\n"
+
+            # Building full string request.
+            # 1. Adding full method line.
+            # 2. Adding headers string.
+            # 3. Adding a line that end headers (with "\r\n").
+            # 4. Adding body as byte string.
+            request_full_no_body: str = method_full + headers_string + "\r\n"
+
+            # Converting the HTTP Request string to bytes and adding 'body' bytes.
+            request_raw_bytes = request_full_no_body.encode() + body
+        except ValueError as exception_object:
+            message = \
+                f'Create Byte request function error, of the of values provided is not standard: {exception_object}'
+            print_api(message, error_type=True, logger=self.logger, logger_method='error', color='red')
+
+            request_raw_bytes = b''
+
+        # Parsing the request we created.
+        request_parse_test = http_parse.HTTPRequestParse(request_raw_bytes)
+        # If there were errors during parsing, it means that something is wrong with response created.
+        if request_parse_test.error_message:
+            self.logger.error(request_parse_test.error_message)
+            request_raw_bytes = b''
+        else:
+            self.logger.info("Created Valid Byte Request.")
+
+        return request_raw_bytes
+
+    def create_request(self, class_client_message: ClientMessage):
+        """ This function should be overridden in the child class. """
+
+        request_bytes: bytes = class_client_message.request_raw_bytes
+        return request_bytes

atomicshop/mitm/engines/__reference_general/requester___reference_general.py

@@ -0,0 +1,46 @@
+# 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
+
+"""
+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):
+    #     # 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/create_module_template.py

@@ -14,6 +14,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__)
@@ -43,10 +44,12 @@ 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.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()
@@ -63,6 +66,7 @@ class CreateModuleTemplate:
 
         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()
@@ -91,13 +95,15 @@ class CreateModuleTemplate:
     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:

{atomicshop-3.0.2.dist-info → atomicshop-3.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 3.0.2
+Version: 3.1.0
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License

{atomicshop-3.0.2.dist-info → atomicshop-3.1.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=GEOC5iHeOiaybq-qC7KhTLKWjsw1mfBb9KDefy9-GIE,122
+atomicshop/__init__.py,sha256=91TkRXyPpHainjVtqMX8IhnOPsq4mLI4-W-pBKoiPbk,122
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/_create_pdf_demo.py,sha256=Yi-PGZuMg0RKvQmLqVeLIZYadqEZwUm-4A9JxBl_vYA,3713
 atomicshop/_patch_import.py,sha256=ENp55sKVJ0e6-4lBvZnpz9PQCt3Otbur7F6aXDlyje4,6334
@@ -136,7 +136,7 @@ atomicshop/file_io/xmls.py,sha256=zh3SuK-dNaFq2NDNhx6ivcf4GYCfGM8M10PcEwDSpxk,21
 atomicshop/mitm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/mitm/config_static.py,sha256=N3D06C_wUytwm80PQCL90ZGHLMHeQlCcI2XQQU2FZ1I,8145
 atomicshop/mitm/config_toml_editor.py,sha256=2p1CMcktWRR_NW-SmyDwylu63ad5e0-w1QPMa8ZLDBw,1635
-atomicshop/mitm/connection_thread_worker.py,sha256=IZtcdW9ZZrtgL-dawt_o56emGCrzWtbd8fUAwgKX9NU,27972
+atomicshop/mitm/connection_thread_worker.py,sha256=H3Ogwo9iMG4WgKZabJGl69_haIkEsMR4p6l4CGbwBYU,28500
 atomicshop/mitm/import_config.py,sha256=MbMgX5IpqC6fUZUTHLOtHyHbzab2tG4RgD2O18csKcI,16506
 atomicshop/mitm/initialize_engines.py,sha256=lucq9LwkWTnrYKsnt8bgs8t9R_y3gOPmzLyEmRuXD8s,6628
 atomicshop/mitm/message.py,sha256=CDhhm4BTuZE7oNZCjvIZ4BuPOW4MuIzQLOg91hJaxDI,3065
@@ -145,15 +145,17 @@ atomicshop/mitm/recs_files.py,sha256=ZAAD0twun-FtmbSniXe3XQhIlawvANNB_HxwbHj7kwI
 atomicshop/mitm/shared_functions.py,sha256=0lzeyINd44sVEfFbahJxQmz6KAMWbYrW5ou3UYfItvw,1777
 atomicshop/mitm/statistic_analyzer.py,sha256=5_sAYGX2Xunzo_pS2W5WijNCwr_BlGJbbOO462y_wN4,27533
 atomicshop/mitm/engines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/mitm/engines/create_module_template.py,sha256=OSX6iM54_PFdo45AMO4f4eToYmLN3UTXZF7mVoQOBko,5104
+atomicshop/mitm/engines/create_module_template.py,sha256=nZE99lwHc_Wm4zmEt7P3cEw3E32Ms65dVbhqZbqOV6U,5577
 atomicshop/mitm/engines/create_module_template_main_example.py,sha256=LeQ44Rp2Gi_KbIDY_4OMS0odkSK3zFZWra_oAka5eJY,243
 atomicshop/mitm/engines/__parent/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/mitm/engines/__parent/parser___parent.py,sha256=HHaCXhScl3OlPjz6eUxsDpJaZyk6BNuDMc9xCkeo2Ws,661
 atomicshop/mitm/engines/__parent/recorder___parent.py,sha256=JbbcpV6j4odvREmvcXQlzKr5_hwLiEHhF0O414PlTes,6010
+atomicshop/mitm/engines/__parent/requester___parent.py,sha256=mKHR1xrfx0CCO74vv164Fr_dVDhptqvYsE3ORoM4_7k,5107
 atomicshop/mitm/engines/__parent/responder___parent.py,sha256=mtiS_6ej9nxT9UhAQR4ftMqnqL-j_kO3u8KEaoEaI9k,9495
 atomicshop/mitm/engines/__reference_general/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/mitm/engines/__reference_general/parser___reference_general.py,sha256=57MEPZMAjTO6xBDZ-yt6lgGJyqRrP0Do5Gk_cgCiPns,2998
 atomicshop/mitm/engines/__reference_general/recorder___reference_general.py,sha256=El2_YHLoHUCiKfkAmGlXxtFpmSjsUFdsb8I1MvSAFaM,653
+atomicshop/mitm/engines/__reference_general/requester___reference_general.py,sha256=yXw8cJ5_0XlupnEtEhqyOR4rvQEAg68Ok39vKa8vKZY,1949
 atomicshop/mitm/engines/__reference_general/responder___reference_general.py,sha256=zVMmON1sy6HH-A35uZZuAURBMfKS5X9ivkPVjPl-sCw,9654
 atomicshop/mitm/statistic_analyzer_helper/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/mitm/statistic_analyzer_helper/analyzer_helper.py,sha256=pk6L1t1ea1kvlBoR9QEJptOmaX-mumhwLsP2GCKukbk,5920
@@ -334,8 +336,8 @@ atomicshop/wrappers/socketw/statistics_csv.py,sha256=WcNyaqEZ82S5-f3kzqi1nllNT2N
 atomicshop/wrappers/winregw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/winregw/winreg_installed_software.py,sha256=Qzmyktvob1qp6Tjk2DjLfAqr_yXV0sgWzdMW_9kwNjY,2345
 atomicshop/wrappers/winregw/winreg_network.py,sha256=3Ts1sVqSUiCDsHRHwJCbiZ9EYvv2ELGxF0Y_pibGU4k,9596
-atomicshop-3.0.2.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-3.0.2.dist-info/METADATA,sha256=aX3egUmln1ZN5f18IVvne582AmpRUfl03XXcoq4EbBk,10653
-atomicshop-3.0.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-3.0.2.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-3.0.2.dist-info/RECORD,,
+atomicshop-3.1.0.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-3.1.0.dist-info/METADATA,sha256=CvGoKMdS-InZlR0Mk23zWG7_g9YqXprrxx05qwPwHiY,10653
+atomicshop-3.1.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-3.1.0.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-3.1.0.dist-info/RECORD,,