atomicshop 2.16.43__py3-none-any.whl → 2.16.44__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__ = '2.16.43'
+__version__ = '2.16.44'

atomicshop/file_io/docxs.py

@@ -75,7 +75,7 @@ def search_for_hyperlink_in_files(directory_path: str, hyperlink: str, relative_
 
     # Get all the docx files in the specified directory.
     files = filesystem.get_paths_from_directory(
-        directory_path, get_file=True, file_name_check_pattern="*\.docx",
+        directory_path, get_file=True, file_name_check_pattern="*.docx",
         add_relative_directory=True, relative_file_name_as_directory=True)
 
     found_in_files: list = list()

atomicshop/websocket_parse.py

@@ -1,18 +1,256 @@
-from typing import Union
+from typing import Union, Generator
 import logging
 
 from websockets.server import ServerProtocol
 from websockets.client import ClientProtocol
-from websockets.extensions.permessage_deflate import ServerPerMessageDeflateFactory, ClientPerMessageDeflateFactory
+from websockets.extensions.permessage_deflate import PerMessageDeflate, ServerPerMessageDeflateFactory, ClientPerMessageDeflateFactory
 from websockets.http11 import Request, Response
-from websockets.frames import Frame, Opcode, Close
+from websockets.frames import Frame, Opcode
 from websockets.uri import parse_uri
 from websockets.exceptions import InvalidHeaderValue
 from websockets.protocol import OPEN
+from websockets.streams import StreamReader
+from websockets.exceptions import ProtocolError, PayloadTooBig
 
 
-class WebsocketRequestParse:
+class WebsocketParseWrongOpcode(Exception):
+    pass
+
+
+def create_byte_http_response(
+        byte_http_request: Union[bytes, bytearray],
+        enable_logging: bool = False
+) -> bytes:
+    """
+    Create a byte HTTP response from a byte HTTP request.
+
+    Parameters:
+    - byte_http_request (bytes, bytearray): The byte HTTP request.
+    - enable_logging (bool): Whether to enable logging.
+
+    Returns:
+    - bytes: The byte HTTP response.
+    """
+
+    # Set up extensions
+    permessage_deflate_factory = ServerPerMessageDeflateFactory()
+
+    # Create the protocol instance
+    protocol = ServerProtocol(
+        extensions=[permessage_deflate_factory],
+    )
+    # At this state the protocol.state is State.CONNECTING
+
+    if enable_logging:
+        logging.basicConfig(level=logging.DEBUG)
+        protocol.logger.setLevel(logging.DEBUG)
+
+
+    protocol.receive_data(byte_http_request)
+    events = protocol.events_received()
+    event = events[0]
+    if isinstance(event, Request):
+        # Accept the handshake.
+        # After the response is sent, it means the handshake was successful, the protocol.state is State.OPEN
+        # Only after this state we can parse frames.
+        response = protocol.accept(event)
+        return response.serialize()
+    else:
+        raise ValueError("The event is not a Request object.")
+
+
+def parse_frame_bytes(data_bytes: bytes):
+    # Define the read_exact function
+    def read_exact(n: int) -> Generator[None, None, bytes]:
+        return reader.read_exact(n)
+
+    # Helper function to run generator-based coroutines
+    def run_coroutine(coroutine):
+        try:
+            while True:
+                next(coroutine)
+        except StopIteration as e:
+            return e.value
+        except Exception as e:
+            raise e  # Re-raise exceptions to be handled by the caller
+
+    # Function to parse frames
+    def parse_frame(mask: bool):
+        try:
+            # Use Frame.parse to parse the frame
+            frame_parser = Frame.parse(
+                read_exact,
+                mask=mask,  # Client frames are masked
+                max_size=None,
+                extensions=[permessage_deflate],  # Include the extension unconditionally
+            )
+            current_frame = run_coroutine(frame_parser)
+        except EOFError as e:
+            # Not enough data to parse a complete frame
+            raise e
+        except (ProtocolError, PayloadTooBig) as e:
+            print("Error parsing frame:", e)
+            raise e
+        except Exception as e:
+            print("Error parsing frame:", e)
+            raise e
+        return current_frame
+
+    def process_frame(current_frame):
+        if current_frame.opcode == Opcode.TEXT:
+            message = current_frame.data.decode('utf-8', errors='replace')
+            return message
+        elif current_frame.opcode == Opcode.BINARY:
+            return current_frame.data
+        elif current_frame.opcode == Opcode.CLOSE:
+            print("Received close frame")
+        elif current_frame.opcode == Opcode.PING:
+            print("Received ping")
+        elif current_frame.opcode == Opcode.PONG:
+            print("Received pong")
+        else:
+            raise WebsocketParseWrongOpcode("Received unknown frame with opcode:", current_frame.opcode)
+
+    # Create the StreamReader instance
+    reader = StreamReader()
+
+    # Instantiate the permessage-deflate extension
+    permessage_deflate = PerMessageDeflate(
+        remote_no_context_takeover=False,
+        local_no_context_takeover=False,
+        remote_max_window_bits=15,
+        local_max_window_bits=15,
+    )
+
+    masked = is_frame_masked(data_bytes)
+
+    # Feed the data into the reader
+    reader.feed_data(data_bytes)
+
+    # Parse and process frames
+    frame = parse_frame(masked)
+    result = process_frame(frame)
+    return result
+
+
+def create_websocket_frame(
+            data: Union[str, bytes, bytearray],
+            deflate: bool = False,
+            mask: bool = False,
+            opcode: int = None
+    ) -> bytes:
+    """
+    Create a WebSocket frame with the given data, optionally applying
+    permessage-deflate compression and masking.
+
+    Parameters:
+    - data (str, bytes, bytearray): The payload data.
+        If str, it will be encoded to bytes using UTF-8.
+    - deflate (bool): Whether to apply permessage-deflate compression.
+    - mask (bool): Whether to apply masking to the frame.
+    - opcode (int): The opcode of the frame. If not provided, it will be
+        determined based on the type of data.
+        Example:
+            from websockets.frames import Opcode
+            Opcode.TEXT, Opcode.BINARY, Opcode.CLOSE, Opcode.PING, Opcode.PONG.
+
+    Returns:
+    - bytes: The serialized WebSocket frame ready to be sent.
+    """
+
+    # Determine the opcode if not provided
+    if opcode is None:
+        if isinstance(data, str):
+            opcode = Opcode.TEXT
+        elif isinstance(data, (bytes, bytearray)):
+            opcode = Opcode.BINARY
+        else:
+            raise TypeError("Data must be of type str, bytes, or bytearray.")
+    else:
+        if not isinstance(opcode, int):
+            raise TypeError("Opcode must be an integer.")
+        if not isinstance(data, (str, bytes, bytearray)):
+            raise TypeError("Data must be of type str, bytes, or bytearray.")
+
+    # Encode string data if necessary
+    if isinstance(data, str):
+        payload = data.encode('utf-8')
+    else:
+        payload = bytes(data)
+
+    # Create the Frame instance
+    frame = Frame(opcode=opcode, data=payload)
+
+    # Set up extensions if deflate is True
+    extensions = []
+    if deflate:
+        permessage_deflate = PerMessageDeflate(
+            remote_no_context_takeover=False,
+            local_no_context_takeover=False,
+            remote_max_window_bits=15,
+            local_max_window_bits=15,
+        )
+        extensions.append(permessage_deflate)
+
+    # Serialize the frame with the specified options
+    try:
+        frame_bytes = frame.serialize(
+            mask=mask,
+            extensions=extensions,
+        )
+    except Exception as e:
+        raise RuntimeError(f"Error serializing frame: {e}")
+
+    return frame_bytes
+
+
+def is_frame_masked(frame_bytes):
+    """
+    Determine whether a WebSocket frame is masked.
+
+    Parameters:
+    - frame_bytes (bytes): The raw bytes of the WebSocket frame.
+
+    Returns:
+    - bool: True if the frame is masked, False otherwise.
+    """
+    if len(frame_bytes) < 2:
+        raise ValueError("Frame is too short to determine masking.")
+
+    # The second byte of the frame header contains the MASK bit
+    second_byte = frame_bytes[1]
+
+    # The MASK bit is the most significant bit (MSB) of the second byte
+    mask_bit = (second_byte & 0x80) != 0  # 0x80 is 1000 0000 in binary
+
+    return mask_bit
+
+
+def is_frame_deflated(frame_bytes):
+    """
+    Determine whether a WebSocket frame is deflated (compressed).
+
+    Parameters:
+    - frame_bytes (bytes): The raw bytes of the WebSocket frame.
+
+    Returns:
+    - bool: True if the frame is deflated (compressed), False otherwise.
+    """
+    if len(frame_bytes) < 1:
+        raise ValueError("Frame is too short to determine deflation status.")
+
+    # The first byte of the frame header contains the RSV1 bit
+    first_byte = frame_bytes[0]
+
+    # The RSV1 bit is the second most significant bit (bit 6)
+    rsv1 = (first_byte & 0x40) != 0  # 0x40 is 0100 0000 in binary
+
+    return rsv1
+
+
+class _WebsocketRequestParse:
     """
+    THIS IS ONLY FOR THE REFERENCE IT IS NOT CURRENTLY USED OR SHOULD BE USED.
     Parse the websocket request and return the data
     """
     def __init__(
@@ -85,8 +323,9 @@ class WebsocketRequestParse:
                 """
 
 
-class WebsocketResponseParse:
+class _WebsocketResponseParse:
     """
+    THIS IS ONLY FOR THE REFERENCE IT IS NOT CURRENTLY USED OR SHOULD BE USED.
     Parse the websocket response and return the data
     """
     def __init__(

atomicshop/wrappers/factw/install/install_after_restart.py

@@ -1,10 +1,35 @@
 from typing import Union, Literal
 from pathlib import Path
 
-from .... import process, filesystem
+from .... import process, print_api
 from .. import config_install
 
 
+PLUGIN_LIST: list = [
+    'qemu_exec',
+    'binwalk',
+    'users_and_passwords',
+    'kernel_config',
+    'cve_lookup',
+    'crypto_hints',
+    'input_vectors',
+    'cwe_checker',
+    'linter',
+    'ip_and_uri_finder',
+    'device_tree',
+    'file_system_metadata',
+    'ipc',
+    'software_components',
+    'architecture_detection',
+    'known_vulnerabilities'
+]
+
+
+INSTALLING_STRINGS: list = ['Installing', 'plugin']
+FINISHED_INSTALLING_STRINGS: list = ['Finished installing', 'plugin']
+LOG_FINISHED_STRING: str = 'installation complete'
+
+
 def install_after_restart(
         installation_directory: str,
         install_type: Union[
@@ -12,8 +37,12 @@ def install_after_restart(
             Literal['backend', 'frontend', 'db']] = None,
         log_level: Union[
             None,
-            Literal['DEBUG', 'INFO', 'WARNING', 'ERROR']] = None
-):
+            Literal['DEBUG', 'INFO', 'WARNING', 'ERROR']] = None,
+        log_file: Union[
+            None,
+            str] = None,
+        analyze_log: bool = False
+) -> int:
     """
     This function will continue the installation the FACT_core after the restart of the computer.
 
@@ -28,7 +57,10 @@ def install_after_restart(
     :param log_level: string, the log level to use for the installation.
         The same as using the '--log-level' parameter in the 'install.py' script.
         The default is 'INFO' in the 'install.py' script.
-    :return:
+    :param log_file: string, the log file to use for the installation.
+        The same as using the '--log-file' parameter in the 'install.py' script.
+    :param analyze_log: bool, if True, the log file will be analyzed for plugin installation errors.
+    :return: int, 0 if the installation was successful, otherwise 1.
     """
 
     install_command: str = 'python3 "' + str(Path(installation_directory, config_install.INSTALL_FILE_PATH)) + '"'
@@ -37,10 +69,51 @@ def install_after_restart(
         install_command = install_command + ' --' + install_type
 
     if log_level:
-        install_command = install_command + ' --log-level ' + log_level
+        install_command = install_command + ' --log_level ' + log_level
+
+    if log_file:
+        install_command = install_command + ' --log_file "' + log_file + '"'
 
     # Install the FACT_core repo.
     process.execute_with_live_output(cmd=install_command, verbose=True)
+
+    # Analyze the log file for errors.
+    if analyze_log and (install_type == 'backend' or install_type is None):
+        if not log_file:
+            log_file = str(Path.cwd() / config_install.INSTALL_LOG_FILE_NAME)
+
+        return analyze_log_file(log_file=log_file)
+
     # Remove the FACT_core installation log.
     # working_directory_path: str = filesystem.get_working_directory()
     # filesystem.remove_file(str(Path(working_directory_path, config_install.INSTALL_LOG_FILE_NAME)))
+
+    return 0
+
+
+def analyze_log_file(log_file: str):
+    """
+    This function will analyze the log file for plugin installation errors.
+    :param log_file:
+    :return:
+    """
+
+    with open(log_file, 'r') as file:
+        log_content: str = file.read()
+
+    for plugin in PLUGIN_LIST:
+        if f'{FINISHED_INSTALLING_STRINGS[0]} {plugin} {FINISHED_INSTALLING_STRINGS[1]}' not in log_content:
+            message = (f'Error: [{plugin}] installation failed.\n'
+                       f'Check the log file: {log_file}\n'
+                       f'Exiting...')
+            print_api.print_api(message, color='red')
+            return 1
+
+    if LOG_FINISHED_STRING not in log_content:
+        message = (f'Error: Installation failed.\n'
+                   f'Check the log file: {log_file}\n'
+                   f'Exiting...')
+        print_api.print_api(message, color='red')
+        return 1
+
+    return 0

{atomicshop-2.16.43.dist-info → atomicshop-2.16.44.dist-info}/METADATA

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

{atomicshop-2.16.43.dist-info → atomicshop-2.16.44.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=eN5mJMelXPzsx3RapgUonBJKKZKyH4jUURpdEWoMogA,124
+atomicshop/__init__.py,sha256=cTkolJcyCusHq9bBDXgphXYHAv5YCLiWysUXbZegGZc,124
 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
@@ -45,7 +45,7 @@ atomicshop/urls.py,sha256=aJ0NGS9qqaKeqjkkWBs80jaBBg6MYBiPuLIyPGxscVc,1557
 atomicshop/uuids.py,sha256=JSQdm3ZTJiwPQ1gYe6kU0TKS_7suwVrHc8JZDGYlydM,2214
 atomicshop/virtualization.py,sha256=LPP4vjE0Vr10R6DA4lqhfX_WaNdDGRAZUW0Am6VeGco,494
 atomicshop/web.py,sha256=GLdTXgMxg1_0UQaXC4bOvARVyuFg7SPIeJdsCHV8rNE,11662
-atomicshop/websocket_parse.py,sha256=Ykva7XI_t-f4H_z0mKxLuyQ04LxZBblHZN_PbYB9idY,6968
+atomicshop/websocket_parse.py,sha256=PygRqEFnqEcPx3PNRtJoZcKN-mXvT_zighzTJR_B-Tc,14934
 atomicshop/a_installs/ubuntu/docker_rootless.py,sha256=9IPNtGZYjfy1_n6ZRt7gWz9KZgR6XCgevjqq02xk-o0,281
 atomicshop/a_installs/ubuntu/docker_sudo.py,sha256=JzayxeyKDtiuT4Icp2L2LyFRbx4wvpyN_bHLfZ-yX5E,281
 atomicshop/a_installs/ubuntu/elastic_search_and_kibana.py,sha256=yRB-l1zBxdiN6av-FwNkhcBlaeu4zrDPjQ0uPGgpK2I,244
@@ -117,7 +117,7 @@ atomicshop/etws/traces/trace_dns.py,sha256=WvOZm7KNdP4r6ofkZhUGi9WjtYlkV3mUp_yxi
 atomicshop/etws/traces/trace_sysmon_process_creation.py,sha256=OM-bkK38uYMwWLZKNOTDa0Xdk3sO6sqsxoMUIiPvm5g,4656
 atomicshop/file_io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/file_io/csvs.py,sha256=jBdm3_z5cMyvxLxJnGcybUAptHAbyL0r0tlLqY0sdTQ,9327
-atomicshop/file_io/docxs.py,sha256=ffJhnmM_WyD8mCoq2dGdpfahdIrGTPy96QVlH5EWjeI,5754
+atomicshop/file_io/docxs.py,sha256=3ctQ9JiGx8K8EYeKWiuraLtqhilW1qk1cZX9lHv0usk,5753
 atomicshop/file_io/file_io.py,sha256=5Kl0P6vF4GQVdwew1lzHLb-db9qiMvDjTgccbi5P-zk,7167
 atomicshop/file_io/jsons.py,sha256=q9ZU8slBKnHLrtn3TnbK1qxrRpj5ZvCm6AlsFzoANjo,5303
 atomicshop/file_io/tomls.py,sha256=ol8EvQPf9sryTmZUf1v55BYSUQ6ml7HVVBHpNKbsIlA,9768
@@ -229,7 +229,7 @@ atomicshop/wrappers/factw/fact_extractor/__init__.py,sha256=47DEQpj8HBSa-_TImW-5
 atomicshop/wrappers/factw/fact_extractor/docker_image.py,sha256=2FyYjnw8gxFNwISQ83OwH-iGivkFi6EAluyCZ0loHEQ,2501
 atomicshop/wrappers/factw/fact_extractor/get_extractor.py,sha256=2mfOAftHIlCcGt1s7MWdq7DsDCuI6wX3MtvcEZ4SK-0,756
 atomicshop/wrappers/factw/install/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/wrappers/factw/install/install_after_restart.py,sha256=zsghES-pyCNiGU2Yix_fFBiDEOWfQ0dtbmyVeZozgL8,2012
+atomicshop/wrappers/factw/install/install_after_restart.py,sha256=cr8E9BAEdpJXJ1VdyXr85byU0PvE3tPV0uPALQOmiKg,4318
 atomicshop/wrappers/factw/install/pre_install_and_install_before_restart.py,sha256=GFsO9MTH0czKoxkiPJtjalilUwsmFLBCcx9Znv37S4M,5945
 atomicshop/wrappers/factw/postgresql/__init__.py,sha256=xMBn2d3Exo23IPP2F_9-SXmOlhFbwWDgS9KwozSTjA0,162
 atomicshop/wrappers/factw/postgresql/analysis.py,sha256=2Rxzy2jyq3zEKIo53z8VkjuslKE_i5mq2ZpmJAvyd6U,716
@@ -315,8 +315,8 @@ atomicshop/wrappers/socketw/ssl_base.py,sha256=kmiif84kMhBr5yjQW17p935sfjR5JKG0L
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=w1AH-zf4mBuT4euf28UKij9ihM-b1BRU9Qfby0QDdqI,2957
 atomicshop/wrappers/winregw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/winregw/winreg_network.py,sha256=ChnVG8ZecKJ-DMF8nUHRiifWJq2M4slEwKat6FBfPfE,8685
-atomicshop-2.16.43.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.16.43.dist-info/METADATA,sha256=QVoeyIJQUE341VUy8UhCrEqSabPP8SLi8qUJjyi6f98,10500
-atomicshop-2.16.43.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.16.43.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.16.43.dist-info/RECORD,,
+atomicshop-2.16.44.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.16.44.dist-info/METADATA,sha256=yeA-HD5CtX5FhTCrJG9ylhYHECkHvJL_ai4gaOnilY4,10500
+atomicshop-2.16.44.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.16.44.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.16.44.dist-info/RECORD,,