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

atomicshop/basics/strings.py

@@ -355,3 +355,20 @@ def check_if_suffix_is_in_string(string: str, suffix: str) -> bool:
     """
 
     return string.endswith(suffix)
+
+
+def convert_string_to_colon_separated(string: str, number_of_characters: int = 2) -> str:
+    """
+    Function converts string to colon separated string.
+    :param string: string, to convert.
+    :param number_of_characters: integer, number of characters to separate.
+
+    Example:
+        convert_string_to_colon_separated('1234567890', 2)
+    Result:
+        '12:34:56:78:90'
+
+    :return: string.
+    """
+
+    return ':'.join([string[i:i+number_of_characters] for i in range(0, len(string), number_of_characters)])

atomicshop/certificates.py

@@ -3,7 +3,85 @@ Site for checking OIDs:
 https://oidref.com/1.3.6.1.5.5.7.3.1
 """
 
+
+import ssl
+
+from .wrappers import cryptographyw
+from .print_api import print_api
+
+
 # Valid for 3 years from now
 # Max validity is 39 months:
 # https://casecurity.org/2015/02/19/ssl-certificate-validity-periods-limited-to-39-months-starting-in-april/
 SECONDS_NOT_AFTER_3_YEARS = 3 * 365 * 24 * 60 * 60
+
+
+def is_certificate_in_store(certificate, issuer_only: bool = False, thumbprint_only: bool = False):
+    """
+    The function will check if the certificate is installed in the Windows certificate store.
+
+    :param certificate: x509 object, certificate to check.
+    :param issuer_only: bool, if True, will check only by the certificate issuer common name is installed in the store.
+        The problem that the issuer common name is not unique, so it can be installed multiple times.
+    :param thumbprint_only: bool, if True, will check only by the certificate thumbprint is installed in the store.
+        The problem that searching by the thumbprint will not tell you if there are multiple certificates with the same
+        issuer name.
+    :return: bool, True if certificate is installed, False if not.
+    """
+
+    # Make sure the certificate is x509.Certificate object.
+    certificate = cryptographyw.convert_object_to_x509(certificate)
+    # Get the certificate thumbprint.
+    thumbprint = cryptographyw.get_sha1_thumbprint_from_x509(certificate)
+    issuer_common_name: str = cryptographyw.get_issuer_common_name_from_x509(certificate)
+
+    # for store in ["CA", "ROOT", "MY"]:
+    for cert, encoding, trust in ssl.enum_certificates("ROOT"):
+        store_certificate = cryptographyw.convert_object_to_x509(cert)
+        store_issuer_common_name: str = cryptographyw.get_issuer_common_name_from_x509(store_certificate)
+        store_thumbprint = cryptographyw.get_sha1_thumbprint_from_x509(store_certificate)
+
+        if issuer_only:
+            if store_issuer_common_name == issuer_common_name:
+                return True, certificate
+        elif thumbprint_only:
+            if store_thumbprint == thumbprint:
+                return True, certificate
+        elif not issuer_only and not thumbprint_only:
+            if store_thumbprint == thumbprint and store_issuer_common_name == issuer_common_name:
+                return True, certificate
+
+
+def get_certificates_by_issuer_name(issuer_name: str, print_kwargs: dict = None):
+    """
+    The function will return all certificates with the specified issuer name.
+
+    :param issuer_name: string, issuer name to search for.
+    :param print_kwargs: dict, that contains all the arguments for 'print_api' function.
+
+    :return: list, of certificates with the specified issuer name.
+    """
+
+    if not print_kwargs:
+        print_kwargs = {}
+
+    certificates_list = []
+
+    for cert, encoding, trust in ssl.enum_certificates("ROOT"):
+        store_certificate = cryptographyw.convert_object_to_x509(cert)
+        store_issuer_common_name: str = cryptographyw.get_issuer_common_name_from_x509(store_certificate)
+
+        if store_issuer_common_name == issuer_name:
+            certificates_list.append(store_certificate)
+
+    if certificates_list:
+        for certificate_single in certificates_list:
+            issuer_name = cryptographyw.get_issuer_common_name_from_x509(certificate_single)
+            thumbprint = cryptographyw.get_sha1_thumbprint_from_x509(certificate_single)
+            message = f'Issuer name: {issuer_name} | Thumbprint: {thumbprint}'
+            print_api(message, **print_kwargs)
+    else:
+        message = f'No certificates with issuer name: {issuer_name}'
+        print_api(message, **print_kwargs)
+
+    return certificates_list

atomicshop/file_io/jsons.py

@@ -1,15 +1,18 @@
 import json
+from typing import Union
 
 from .file_io import read_file_decorator, write_file_decorator
 
 
 # noinspection PyUnusedLocal
 @read_file_decorator
-def read_json_file(file_path: str,
-                   file_mode: str = 'r',
-                   encoding=None,
-                   file_object=None,
-                   **kwargs) -> dict:
+def read_json_file(
+        file_path: str,
+        file_mode: str = 'r',
+        encoding=None,
+        file_object=None,
+        **kwargs
+) -> dict:
     """
     Read the json file and return its content as dictionary.
 
@@ -27,13 +30,15 @@ def read_json_file(file_path: str,
 
 # noinspection PyUnusedLocal
 @write_file_decorator
-def write_json_file(json_content,
-                    file_path: str,
-                    file_mode: str = 'w',
-                    indent=None,
-                    use_default_indent=False,
-                    file_object=None,
-                    **kwargs) -> None:
+def write_json_file(
+        json_content: Union[list, dict, str],
+        file_path: str,
+        file_mode: str = 'w',
+        indent=None,
+        use_default_indent=False,
+        file_object=None,
+        **kwargs
+) -> None:
     """
     Export list or dict to json file. If indent specified, the content will be beautified by the number of spaces
     specified in 'indent' integer.
@@ -69,3 +74,25 @@ def write_json_file(json_content,
         # If so, write it to file as regular string.
         # Getting the 'file_object' from the 'write_file_decorator'.
         file_object.write(json_content)
+
+
+def convert_dict_to_json_string(
+        dict_or_list: Union[dict, list],
+        indent=None,
+        use_default_indent=False) -> str:
+    """
+    Convert dictionary or list of dictionaries to json formatted string.
+
+    :param dict_or_list: dictionary or list of dictionaries to convert.
+    :param indent: integer number of spaces for indentation.
+        If 'ident=0' new lines still will be created. The most compact is 'indent=None' (from documentation)
+        So, using default as 'None' and not something else.
+    :param use_default_indent: boolean. Default indent for 'json' format in many places is '2'. So, if you don't want
+        to set 'indent=2', just set this to 'True'.
+    :return: json formatted string.
+    """
+
+    if use_default_indent:
+        indent = 2
+
+    return json.dumps(dict_or_list, indent=indent)

atomicshop/hashing.py

@@ -1,10 +1,19 @@
 import hashlib
 import sys
+from typing import Literal, Union
 
 from . import web
 
 
-def hash_bytes(bytes_object: bytes, hash_algo: str = 'sha256'):
+# def hash_bytes(bytes_object: bytes, hash_algo: Union[Literal['sha256', 'md5', 'sha1'], str] = 'sha256') -> str:
+def hash_bytes(bytes_object: bytes, hash_algo: str = 'sha256') -> str:
+    """
+    The function will return hash of the bytes object with specified algorithm.
+    :param bytes_object: bytes object to hash.
+    :param hash_algo: string, file hashing algorithm. Default is 'sha256'. Basically the string can be any algorithm
+        that hashlib supports. Example: hashlib.sha256(), hashlib.md5(), hashlib.sha1()
+    :return: string, hash of the bytes object.
+    """
     # Equivalent to sha256 example: hashlib.sha256(bytes_object).hexdigest()
     return getattr(hashlib, hash_algo)(bytes_object).hexdigest()
 

atomicshop/ip_addresses.py

@@ -1,7 +1,8 @@
 import ipaddress
+from typing import Union, Literal
 
 
-def is_ip_address(string_value: str, ip_type: str = None) -> bool:
+def is_ip_address(string_value: str, ip_type: Union[Literal['ipv4', 'ipv6'], None] = None) -> bool:
     """
     The function checks if the string is an IPv4 or IPv6 address.
 

atomicshop/urls.py

@@ -1,5 +1,3 @@
-# v1.0.0
-# Basic imports.
 from urllib.parse import urlparse
 
 

atomicshop/wrappers/cryptographyw.py

@@ -1,6 +1,11 @@
+from typing import Union
+import os
+
 from ..print_api import print_api
+from ..file_io import file_io
 
 from cryptography import x509
+from cryptography.x509 import Certificate
 from cryptography.hazmat.primitives.asymmetric import rsa
 from cryptography.hazmat.primitives import serialization
 from cryptography.hazmat.primitives import hashes
@@ -17,7 +22,50 @@ OID_TO_BUILDER_CLASS_EXTENSION_NAME: dict = {
 }
 
 
-def convert_pem_to_x509_object(certificate):
+def convert_object_to_x509(certificate):
+    """Convert certificate to x509 object.
+
+    :param certificate: any object that can be converted to x509 object.
+        Supported types:
+            string that is path to file will be imported as bytes object abd converted to x509.Certificate
+                After check if it's PEM or DER format.
+            string that is PEM certificate will be converted to bytes, then x509.Certificate
+            bytes of PEM or DER will be converted to x509.Certificate.
+            x509.Certificate will be returned as is.
+    :return: certificate in x509 object of 'cryptography' module.
+    """
+
+    # Check if 'certificate' is a string and a path.
+    if isinstance(certificate, str) and os.path.isfile(certificate):
+        # Import the certificate from the path.
+        certificate = file_io.read_file(certificate, file_mode='rb')
+
+    # Check if 'certificate' is a bytes object and PEM format.
+    # We're checking if it starts with '-----BEGIN ' since the pem certificate can include PRIVATE KEY and will be
+    # in the beginning of the file.
+    if (isinstance(certificate, bytes) and certificate.startswith(b'-----BEGIN ') and
+            b'-----BEGIN CERTIFICATE-----' in certificate):
+        # Convert the PEM certificate to x509 object.
+        certificate = convert_pem_to_x509_object(certificate)
+    # Check if 'certificate' is a bytes object and DER format.
+    elif isinstance(certificate, bytes) and certificate.startswith(b'\x30'):
+        # Convert the DER certificate to x509 object.
+        certificate = convert_der_to_x509_object(certificate)
+    # Check if 'certificate' is a string object and PEM format.
+    elif (isinstance(certificate, str) and certificate.startswith('-----BEGIN ') and
+          '-----BEGIN CERTIFICATE-----' in certificate):
+        # Convert the PEM certificate to x509 object.
+        certificate = convert_pem_to_x509_object(certificate)
+    # Check if 'certificate' is a x509 object.
+    elif isinstance(certificate, Certificate):
+        pass
+    else:
+        raise ValueError(f'Unsupported certificate type: {type(certificate)}')
+
+    return certificate
+
+
+def convert_pem_to_x509_object(certificate: Union[str, bytes]) -> x509.Certificate:
     """Convert PEM certificate to x509 object.
 
     :param certificate: string or bytes - certificate to convert.
@@ -51,6 +99,16 @@ def convert_x509_object_to_pem_bytes(certificate) -> bytes:
     return certificate.public_bytes(serialization.Encoding.PEM)
 
 
+def convert_x509_object_to_der_bytes(certificate) -> bytes:
+    """Convert x509 object to DER certificate.
+
+    :param certificate: certificate in x509 object of 'cryptography' module.
+    :return: bytes of certificate in DER byte string format.
+    """
+
+    return certificate.public_bytes(serialization.Encoding.DER)
+
+
 def generate_private_key(public_exponent: int = 65537, bits: int = 2048):
     private_key = rsa.generate_private_key(
         public_exponent=public_exponent,
@@ -186,3 +244,41 @@ def _get_extensions_properties(certificate):
             sub_keys = vars(ext._value)
 
         print(f'{ext.oid._name}: {sub_keys}')
+
+
+def get_sha1_thumbprint_from_x509(certificate) -> str:
+    """Get SHA1 thumbprint of the certificate.
+
+    :param certificate: certificate in x509 object of cryptography module.
+    :return: string, SHA1 thumbprint of the certificate.
+    """
+
+    return certificate.fingerprint(hashes.SHA1()).hex()
+
+
+def get_sha1_thumbprint_from_pem(pem_certificate: bytes) -> str:
+    """Get SHA1 thumbprint of the certificate.
+
+    :param pem_certificate: bytes of PEM certificate.
+    :return: string, SHA1 thumbprint of the certificate.
+    """
+
+    # Convert PEM certificate to x509 object.
+    certificate = convert_pem_to_x509_object(pem_certificate)
+
+    return get_sha1_thumbprint_from_x509(certificate)
+
+
+def get_issuer_common_name_from_x509(certificate) -> str:
+    """Get issuer common name from x509 certificate.
+
+    :param certificate: certificate in x509 object of cryptography module.
+    :return: string, issuer common name.
+    """
+
+    try:
+        issuer = certificate.issuer.get_attributes_for_oid(x509.NameOID.COMMON_NAME)[0].value
+    except IndexError:
+        issuer = certificate.issuer.get_attributes_for_oid(x509.NameOID.ORGANIZATION_NAME)[0].value
+
+    return issuer

atomicshop/wrappers/factw/fact_config.py

@@ -2,3 +2,5 @@ FACT_ADDRESS: str = 'http://localhost:5000'
 FIRMWARE_ENDPOINT: str = '/rest/firmware'
 FILE_OBJECT_ENDPOINT: str = '/rest/file_object'
 STATUS_ENDPOINT: str = '/rest/status'
+STATISTICS_ENDPOINT: str = '/rest/statistics'
+BINARY_SEARCH_ENDPOINT: str = '/rest/binary_search'

atomicshop/wrappers/factw/rest_binary_search.py

@@ -0,0 +1,29 @@
+# noinspection PyPackageRequirements
+import requests
+
+from . import fact_config
+from ... print_api import print_api
+
+
+def search_string(string_to_search: str):
+    """
+    Get the binaries by searching for a string.
+    :return:
+    """
+
+    yara_rule = {
+        "rule_file": "rule rulename {strings: $a = \"" + string_to_search + "\" condition: $a }"
+    }
+
+    url: str = f'{fact_config.FACT_ADDRESS}{fact_config.BINARY_SEARCH_ENDPOINT}'
+    response: requests.Response = requests.get(url, json=yara_rule)
+
+    # Check response status code.
+    if response.status_code == 200:
+        # Print response.
+        print_api(response.json())
+    else:
+        # Print error.
+        print_api('Error: ' + str(response.status_code), error_type=True, logger_method='critical')
+
+    return response

atomicshop/wrappers/factw/rest_file_object.py

@@ -2,14 +2,34 @@
 import requests
 
 from . import fact_config, get_file_data
-from ... print_api import print_status_of_list
+from ... print_api import print_status_of_list, print_api
 
 
-def is_uid_exist(uid: str):
+def get_all_file_objects():
     """
-    Check if the specified FACT UID exists in the FILE_OBJECT database.
+    Get all file_object UIDs from the database.
+    :return:
+    """
+
+    url: str = f'{fact_config.FACT_ADDRESS}{fact_config.FILE_OBJECT_ENDPOINT}'
+    response: requests.Response = requests.get(url)
+
+    # Check response status code.
+    if response.status_code == 200:
+        # Print response.
+        print_api(response.json())
+    else:
+        # Print error.
+        print_api('Error: ' + str(response.status_code), error_type=True, logger_method='critical')
+
+    return response
+
+
+def get_uid_data(uid: str):
+    """
+    Get file_object data by UID.
     :param uid: string, FACT UID.
-    :return: boolean, True if exists, False if not.
+    :return:
     """
 
     url: str = f'{fact_config.FACT_ADDRESS}{fact_config.FILE_OBJECT_ENDPOINT}/{uid}'
@@ -17,6 +37,19 @@ def is_uid_exist(uid: str):
 
     # Check response status code.
     if response.status_code == 200:
+        return response.json()
+    else:
+        return None
+
+
+def is_uid_exist(uid: str):
+    """
+    Check if the specified FACT UID exists in the FILE_OBJECT database.
+    :param uid: string, FACT UID.
+    :return: boolean, True if exists, False if not.
+    """
+
+    if get_uid_data(uid):
         return True
     else:
         return False

atomicshop/wrappers/factw/rest_firmware.py

@@ -2,11 +2,112 @@
 import requests
 import base64
 import time
+from typing import Union
+import os
 
 from . import fact_config, get_file_data, rest_file_object
-from ... print_api import print_api, print_status_of_list
-from ... file_io import file_io
-from ... import filesystem
+from ...print_api import print_api, print_status_of_list
+from ...file_io import file_io, jsons, csvs
+from ...basics import dicts
+from ... import filesystem, ip_addresses
+
+
+def get_uid_list(
+        config_data: dict,
+        query: Union[dict, str] = None,
+        url_parameters: dict = None,
+        fetch_uid_data: bool = False
+):
+    """
+    Get firmware UIDs by query.
+    :param config_data: dict, of Parameters to pass for REST API.
+        If query is specified, this parameter is ignored.
+    :param query: string, query.
+        Example:
+            {$and: [{"device_name": "test"}, {"device_name": "test222"}]}
+        Info:
+            Return UIDs of all firmwares with device_name "test" and device_name "test222".
+
+        Example2:
+            {"vendor": "AVM"}
+        Info:
+            Return UIDs of all firmwares with vendor "AVM".
+
+        Operators:
+            $and: AND operator.
+            $or: OR operator.
+            $ne: NOT EQUAL operator.
+            $like: LIKE operator.
+            $in: IN operator.
+            &lt: LESS THAN operator.
+            $gt: GREATER THAN operator.
+            $exists: EXISTS operator.
+            $regex: REGEX operator.
+            $contains: CONTAINS operator.
+            Basically all the operators that are supported by the MongoDB.
+
+    :param url_parameters: dict, of URL parameters. Available parameters:
+        {
+            'limit': int - limit of results,
+            'offset': int - offset of results (paging),
+            'recursive': boolean - recursive search - only with query,
+            'inverted': boolean - inverted search - only with query and recursive
+        }
+
+    :param fetch_uid_data: boolean, get data of the UIDs. This can take time, since each UID will be queried against the
+        database. Default is False.
+    :return: list, list of UIDs.
+    """
+
+    url: str = f'{fact_config.FACT_ADDRESS}{fact_config.FIRMWARE_ENDPOINT}'
+
+    if query is None:
+        if 'requested_analysis_systems' in config_data:
+            dicts.remove_keys(config_data, ['requested_analysis_systems'])
+
+        query = config_data
+
+    if isinstance(query, dict):
+        query = jsons.convert_dict_to_json_string(query)
+    elif isinstance(query, str):
+        pass
+    else:
+        raise TypeError(f'Query must be dict or string, not {type(query)}')
+
+    # If there are parameters to add to the URL, add the '?' to the URL.
+    if url_parameters or query:
+        url = f'{url}?'
+
+    # Add parameters to the URL.
+    if url_parameters and query:
+        for key, value in url_parameters.items():
+            url = f'{url}{key}={str(value)}&'
+            url = f'{url}query={query}'
+    if url_parameters and not query:
+        for parameter_index, (key, value) in enumerate(url_parameters.items()):
+            url = f'{url}{key}={str(value)}'
+            if parameter_index < len(url_parameters) - 1:
+                url = f'{url}&'
+    elif query and not url_parameters:
+        url = f'{url}query={query}'
+
+    response: requests.Response = requests.get(url)
+
+    uids: list = list()
+    # Check response status code.
+    if response.status_code == 200:
+        uids: list = response.json()['uids']
+        # Print response.
+        # print_api(response.json())
+        print_api(f'Found {len(uids)} UIDs.')
+    else:
+        # Print error.
+        print_api('Error: ' + str(response.status_code), error_type=True, logger_method='critical')
+
+    if fetch_uid_data:
+        return get_uid_list_data(uids)
+    else:
+        return uids
 
 
 def is_analysis_finished(uid: str) -> bool:
@@ -177,11 +278,11 @@ def upload_files(directory_path: str, json_data: dict):
     return None
 
 
-def is_uid_exist(uid: str):
+def get_uid_data(uid: str):
     """
-    Check if the specified FACT UID exists in the FIRMWARE database.
+    Get firmware data by UID.
     :param uid: string, FACT UID.
-    :return: boolean, True if exists, False if not.
+    :return:
     """
 
     url: str = f'{fact_config.FACT_ADDRESS}{fact_config.FIRMWARE_ENDPOINT}/{uid}'
@@ -189,6 +290,35 @@ def is_uid_exist(uid: str):
 
     # Check response status code.
     if response.status_code == 200:
+        return response.json()
+    else:
+        return None
+
+
+def get_uid_list_data(uid_list: list):
+    """
+    Get firmware data for each UID in the list.
+    :param uid_list: list, list of FACT UIDs.
+    :return:
+    """
+
+    uid_data_list: list = list()
+    for uid_index, uid in enumerate(uid_list):
+        print_status_of_list(
+            list_instance=uid_list, prefix_string='Getting UID Data: ', current_state=(uid_index + 1))
+        uid_data_list.append(get_uid_data(uid))
+
+    return uid_data_list
+
+
+def is_uid_exist(uid: str):
+    """
+    Check if the specified FACT UID exists in the FIRMWARE database.
+    :param uid: string, FACT UID.
+    :return: boolean, True if exists, False if not.
+    """
+
+    if get_uid_data(uid):
         return True
     else:
         return False
@@ -245,3 +375,141 @@ def is_firmware_exist(directory_path: str, firmwares: list = None) -> list:
         raise ValueError(message)
 
     return firmwares
+
+
+def find_analysis_recursively(uid: str, object_path: str = str()):
+    """
+    The function will find the analysis information like cve, OS type, etc. recursively and return it to
+    the asker firmware.
+
+    :param uid: string of the uid of the file_object.
+    :param object_path: string of the path of the file_object. Can be empty on the first iteration since it's the same
+        UID as the first asker function.
+    :return:
+    """
+
+    found_info: dict = dict()
+
+    # Get the data of the firmware.
+    file_data: dict = rest_file_object.get_uid_data(uid)
+
+    # Add current path to the object path to create a full path of the current object.
+    current_path: str = object_path + file_data['file_object']['meta_data']['hid']
+    print_api(f"Current File: {current_path}", print_end='\r')
+
+    cve_lookup_result: dict = file_data['file_object']['analysis']['cve_lookup']['result']
+    ip_and_uri_finder_result: dict = file_data['file_object']['analysis']['ip_and_uri_finder']['result']
+    software_components_result: dict = file_data['file_object']['analysis']['software_components']['result']
+
+    if cve_lookup_result and 'skipped' not in cve_lookup_result.keys():
+        if cve_lookup_result['cve_results']:
+            found_info['cve_lookup'] = file_data['file_object']['analysis']['cve_lookup']['result']
+    if ip_and_uri_finder_result and 'skipped' not in ip_and_uri_finder_result.keys():
+        if ip_and_uri_finder_result['ips_v4'] or ip_and_uri_finder_result['ips_v6'] or ip_and_uri_finder_result['uris']:
+            found_info['ip_and_uri_finder'] = file_data['file_object']['analysis']['ip_and_uri_finder']['result']
+    if software_components_result and 'skipped' not in software_components_result.keys():
+        found_info['software_components'] = file_data['file_object']['analysis']['software_components']['result']
+
+    if found_info:
+        found_info['path'] = current_path
+        found_files: list = [found_info]
+    else:
+        found_files: list = list()
+
+    for included_file_uid in file_data['file_object']['meta_data']['included_files']:
+        # Get the data of the included file.
+        included_found_files = find_analysis_recursively(included_file_uid, (
+                object_path + file_data['file_object']['meta_data']['hid']))
+
+        if included_found_files:
+            found_files.extend(included_found_files)
+
+    return found_files
+
+
+def save_firmware_uids_as_csv(
+        directory_path: str,
+        config_data: dict = None,
+        query: Union[dict, str] = None,
+        url_parameters: dict = None,
+        get_analysis_data: bool = False
+):
+    """
+    Save firmware UIDs as CSV file.
+    :param directory_path: string, path to save the CSV file.
+    :param config_data: check get_uid_list() for more info.
+    :param query: check get_uid_list() for more info.
+    :param url_parameters: check get_uid_list() for more info.
+    :param get_analysis_data: boolean. If 'True', the function will get the analysis data of each file that is found
+        in the firmware results. This is needed in order to determine if the firmware is vulnerable to CVEs, OS type,
+        etc. Default is 'False'.
+        NOTE: This can take a lot of time, since each internal file will be queried against the database.
+
+    :return:
+    """
+
+    uids: list = get_uid_list(
+        config_data=config_data, query=query, url_parameters=url_parameters, fetch_uid_data=True)
+
+    export_list: list = list()
+    for uid_index, uid in enumerate(uids):
+        print_status_of_list(
+            list_instance=uids, prefix_string='Checking UID for analysis items: ', current_state=(uid_index + 1),
+            same_line=False)
+        export_entry: dict = dict()
+        for key, value in uid['firmware']['meta_data'].items():
+            if key == 'included_files' or key == 'total_files_in_firmware':
+                continue
+            export_entry[key] = value
+
+        export_entry['mime'] = uid['firmware']['analysis']['file_type']['result']['mime']
+        export_entry['sha256'] = uid['firmware']['analysis']['file_hashes']['result']['sha256']
+        export_entry['uid'] = uid['request']['uid']
+
+        # Check for CVEs and other info recursively.
+        if get_analysis_data:
+            analysis_data_list = find_analysis_recursively(uid['request']['uid'])
+        else:
+            analysis_data_list = list()
+
+        export_entry['urls_ips']: list = list()
+        export_entry['cves']: list = list()
+        export_entry['software']: list = list()
+
+        for analysis_data in analysis_data_list:
+            if 'cve_lookup' in analysis_data:
+                for key, value in analysis_data['cve_lookup']['cve_results'].items():
+                    export_entry['cves'] = [key, jsons.convert_dict_to_json_string(value)]
+            if 'software_components' in analysis_data:
+                for key, value in analysis_data['software_components'].items():
+                    export_entry['software'] = [key, jsons.convert_dict_to_json_string(value['meta'])]
+            if 'ip_and_uri_finder' in analysis_data:
+                for key, value in analysis_data['ip_and_uri_finder'].items():
+                    if not value:
+                        continue
+
+                    if key == 'ips_v4':
+                        for ipv4s in analysis_data['ip_and_uri_finder']['ips_v4']:
+                            for ip_address in ipv4s:
+                                if ip_addresses.is_ip_address(ip_address, ip_type='ipv4'):
+                                    if ip_address not in export_entry['urls_ips']:
+                                        export_entry['urls_ips'].append(ip_address)
+                    elif key == 'ips_v6':
+                        for ipv6s in analysis_data['ip_and_uri_finder']['ips_v6']:
+                            for ip_address in ipv6s:
+                                if ip_addresses.is_ip_address(ip_address, ip_type='ipv6'):
+                                    if ip_address not in export_entry['urls_ips']:
+                                        export_entry['urls_ips'].append(ip_address)
+                    elif key == 'uris':
+                        for address in value:
+                            if address not in export_entry['urls_ips']:
+                                export_entry['urls_ips'].append(address)
+
+        export_list.append(export_entry)
+        # break
+
+    # Save UIDs as CSV file.
+    file_path = directory_path + os.sep + 'uids.csv'
+    csvs.write_list_to_csv(export_list, file_path)
+
+    return None

atomicshop/wrappers/factw/rest_router.py

@@ -0,0 +1,19 @@
+from .import rest_firmware, rest_statistics, rest_binary_search
+
+
+def endpoint_router(config: dict):
+    """
+    Route the endpoint.
+    :param config: dict, configuration dictionary.
+    :return:
+    """
+
+    if config['method'] == 'upload_firmware':
+        rest_firmware.upload_files(config['firmwares_path'], config['data'])
+    elif config['method'] == 'firmware_csv':
+        rest_firmware.save_firmware_uids_as_csv(
+            directory_path=config['output_path'], config_data=config['data'], get_analysis_data=True)
+    elif config['method'] == 'get_statistics':
+        rest_statistics.get_statistics()
+    elif config['method'] == 'binary_search':
+        rest_binary_search.search_string(config['data']['vendor'])

atomicshop/wrappers/factw/rest_statistics.py

@@ -0,0 +1,25 @@
+# noinspection PyPackageRequirements
+import requests
+
+from . import fact_config
+from ... print_api import print_api
+
+
+def get_statistics():
+    """
+    Get statistics of the FACT service.
+    :return:
+    """
+
+    url: str = f'{fact_config.FACT_ADDRESS}{fact_config.STATISTICS_ENDPOINT}'
+    response: requests.Response = requests.get(url)
+
+    # Check response status code.
+    if response.status_code == 200:
+        # Print response.
+        print_api(response.json())
+    else:
+        # Print error.
+        print_api('Error: ' + str(response.status_code), error_type=True, logger_method='critical')
+
+    return response

atomicshop/wrappers/factw/rest_status.py

@@ -5,7 +5,7 @@ from . import fact_config
 from ... print_api import print_api
 
 
-def get_global_status():
+def get_status():
     """
     Get status of the FACT service.
     :return:

{atomicshop-2.3.11.dist-info → atomicshop-2.4.1.dist-info}/METADATA

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

{atomicshop-2.3.11.dist-info → atomicshop-2.4.1.dist-info}/RECORD

@@ -1,8 +1,8 @@
-atomicshop/__init__.py,sha256=RXJOc2XvRYb29W-vu4kK-A5DOmU0yyRQPxnJEQOvkKI,123
+atomicshop/__init__.py,sha256=i3jQ-IHva0gZoh8TLttLwDYpRvGzWReWzwOG8PZkTyU,122
 atomicshop/_basics_temp.py,sha256=6cu2dd6r2dLrd1BRNcVDKTHlsHs_26Gpw8QS6v32lQ0,3699
 atomicshop/appointment_management.py,sha256=N3wVGJgrqJfsj_lqiRfaL3FxMEe57by5Stzanh189mk,7263
 atomicshop/archiver.py,sha256=E4dgAuh6ARtAWRW6Q0RdnMRMzsE_S1NjMiajHRIVG9s,5537
-atomicshop/certificates.py,sha256=nxuq6HPBT7RfwRTSipOxoRHBS-nZLsaHR9m6UdHmDn4,297
+atomicshop/certificates.py,sha256=J-cmd6Rpq3zZyzsOH-GcdqIXdg2UwM8_E9mg7XtUph8,3787
 atomicshop/command_line_processing.py,sha256=u5yT9Ger_cu7ni5ID0VFlRbVD46ARHeNC9tRM-_YXrQ,1038
 atomicshop/console_output.py,sha256=G-6jxnWooT1nJSaPxcCqIuw8S22R_0lOJcfrdovRhwE,1372
 atomicshop/console_user_response.py,sha256=31HIy9QGXa7f-GVR8MzJauQ79E_ZqAeagF3Ks4GGdDU,3234
@@ -14,10 +14,10 @@ atomicshop/emails.py,sha256=I0KyODQpIMEsNRi9YWSOL8EUPBiWyon3HRdIuSj3AEU,1410
 atomicshop/filesystem.py,sha256=mS7o_o01HiC12G79z2_txvzM6YLNAWrfNC9IhOJRq6w,23684
 atomicshop/functions.py,sha256=VqLjxAxhaxUr-Ad8P1cw9bZGdZpbtqfCaXQyHf3CM9g,509
 atomicshop/github_wrapper.py,sha256=7pZkhliP4vdcdeVtbgTDEzBS3lUw3-mp5PMWUDA19V0,4347
-atomicshop/hashing.py,sha256=6523xFxuW0Cm1pcJCE63NWeiwt3al3t-FXLv0f0Kzpg,2989
+atomicshop/hashing.py,sha256=k_HXR7FnPUzLUKk8EiewJ_gLFBlWncZluiBwzplFMWs,3548
 atomicshop/http_parse.py,sha256=nrf2rZcprLqtW8HVrV7TCZ1iTBcWRRy-mXIlAOzcaJs,9703
 atomicshop/inspect_wrapper.py,sha256=sGRVQhrJovNygHTydqJj0hxES-aB2Eg9KbIk3G31apw,11429
-atomicshop/ip_addresses.py,sha256=fvBwLFGbcNV87s_UzZZs0MO-TPwDEak_0SB4_syhefM,691
+atomicshop/ip_addresses.py,sha256=GBG9YXEqHItmGEgKwqatx28CbWislFI2ZI2xVHGIqO4,759
 atomicshop/keyboard_press.py,sha256=1W5kRtOB75fulVx-uF2yarBhW0_IzdI1k73AnvXstk0,452
 atomicshop/pbtkmultifile_argparse.py,sha256=aEk8nhvoQVu-xyfZosK3ma17CwIgOjzO1erXXdjwtS4,4574
 atomicshop/permissions.py,sha256=CYTDVOI0jh9ks0ZLnnOuPzppgCszFEc9-92DTkVTYi4,522
@@ -36,7 +36,7 @@ atomicshop/ssh_remote.py,sha256=Sas3nrQv8ardxR51t59xZZsYm8nvUcA7tMSqEDViRLk,1715
 atomicshop/sys_functions.py,sha256=MTBxRve5bh58SPvhX3gMiGqHlSBuI_rdNN1NnnBBWqI,906
 atomicshop/tempfiles.py,sha256=uq1ve2WlWehZ3NOTXJnpBBMt6HyCdBufqedF0HyzA6k,2517
 atomicshop/timer.py,sha256=KxBBgVM8po6pUJDW8TgY1UXj0iiDmRmL5XDCq0VHAfU,1670
-atomicshop/urls.py,sha256=2vVWXeue6NyuW-RHORrkSeJEl9tQM71rW8DC7_SnR6c,625
+atomicshop/urls.py,sha256=CQl1j1kjEVDlAuYJqYD9XxPF1SUSgrmG8PjlcXNEKsQ,597
 atomicshop/web.py,sha256=9cxzGhk16PU0daHi-mxSNH4r7LATDh527oN7fZ1dSMk,11003
 atomicshop/addons/PlayWrightCodegen.cmd,sha256=Z5cnllsyXD4F1W2h-WLEnyFkg5nZy0-hTGHRWXVOuW4,173
 atomicshop/addons/ScriptExecution.cmd,sha256=8iC-uHs9MX9qUD_C2M7n9Xw4MZvwOfxT8H5v3hluVps,93
@@ -68,7 +68,7 @@ atomicshop/basics/lists.py,sha256=ZyTjHyvkta-4_xCG1P-LFMENELmgAYlDdPq4hMRAOR8,25
 atomicshop/basics/multiprocesses.py,sha256=GVeyF-r9Q6SAjpJ46eqkZQ4QUli554n-CAIE_W8pij8,958
 atomicshop/basics/numbers.py,sha256=FRjAH1Thk3z3ayxq0Ik6Wh93ELDRk1geyDYTv8amZBE,165
 atomicshop/basics/randoms.py,sha256=DmYLtnIhDK29tAQrGP1Nt-A-v8WC7WIEB8Edi-nk3N4,282
-atomicshop/basics/strings.py,sha256=e_jq1huII_JnE82fUnMPqirZIKfbS6axnxhxK6jJzkM,12919
+atomicshop/basics/strings.py,sha256=fufYRPe-JUiwm_ENy7bmz-avQ6svAS0yEJ1Tuo3gXVA,13457
 atomicshop/basics/threads.py,sha256=xvgdDJdmgN0wmmARoZ-H7Kvl1GOcEbvgaeGL4M3Hcx8,2819
 atomicshop/basics/timeit_template.py,sha256=fYLrk-X_dhdVtnPU22tarrhhvlggeW6FdKCXM8zkX68,405
 atomicshop/basics/tracebacks.py,sha256=cNfh_oAwF55kSIdqtv3boHZQIoQI8TajxkTnwJwpweI,535
@@ -78,7 +78,7 @@ atomicshop/etw/etw.py,sha256=xVJNbfCq4KgRfsDnul6CrIdAMl9xRBixZ-hUyqiB2g4,2403
 atomicshop/file_io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/file_io/csvs.py,sha256=4R4Kij8FmxNwXFjDtlF_A0flAk0Hj5nZKlEnqC5VxgQ,3125
 atomicshop/file_io/file_io.py,sha256=kaRMSm8sNrnos1gqgAcPVkUXjXgZE-uW_STueqsFZyw,5657
-atomicshop/file_io/jsons.py,sha256=sQjWtNXsM6HjtrSG2FIicT1Alp8ASC0yfY8VL-xoDR4,3354
+atomicshop/file_io/jsons.py,sha256=4xCnC6MfajLouXUFl2aVXUPvftQVf2eS5DgydPZHF_c,4170
 atomicshop/file_io/tomls.py,sha256=T-K4l9FvkSN3eOBoAduPtlFkgW7JqUds6wDMRpZyG6U,1057
 atomicshop/file_io/xlsxs.py,sha256=v_dyg9GD4LqgWi6wA1QuWRZ8zG4ZwB6Dz52ytdcmmmI,2184
 atomicshop/file_io/xmls.py,sha256=sQvTKqUEAoMa9rxCvJJV2EiUE7UoTX6fa1REt-n6MVQ,1650
@@ -117,7 +117,7 @@ atomicshop/wrappers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 atomicshop/wrappers/_process_wrapper_curl.py,sha256=XkZZXYl7D0Q6UfdWqy-18AvpU0yVp9i2BVD2qRcXlkk,841
 atomicshop/wrappers/_process_wrapper_tar.py,sha256=WUMZFKNrlG4nJP9tWZ51W7BR1j_pIjsjgyAStmWjRGs,655
 atomicshop/wrappers/configparserw.py,sha256=Li2yb3SL8p1GMRRd_r9dNVYuEKGdlQRPIwAHBc5YF1A,17201
-atomicshop/wrappers/cryptographyw.py,sha256=vOsDqyn4_aMOqYfArw5gB5bFNW21KJBDAcw22e80uxo,9239
+atomicshop/wrappers/cryptographyw.py,sha256=H5NaHHDkr97QYhUrHFO9vY218u8k3N3Zgh6bQRnicUE,13140
 atomicshop/wrappers/ffmpegw.py,sha256=YKptcdNQC1wyPLRLvc24fIPr4_rj8IHH01UUzt6XFO0,6039
 atomicshop/wrappers/numpyw.py,sha256=sBV4gSKyr23kXTalqAb1oqttzE_2XxBooCui66jbAqc,1025
 atomicshop/wrappers/process_wrapper_pbtk.py,sha256=rB3izJqJxs4cv6aNi1mryxrfNqHClH6GywmGSlyI_5Y,688
@@ -127,11 +127,14 @@ atomicshop/wrappers/certauthw/certauth.py,sha256=hKedW0DOWlEigSNm8wu4SqHkCQsGJ1t
 atomicshop/wrappers/certauthw/certauthw.py,sha256=4WvhjANI7Kzqrr_nKmtA8Kf7B6rute_5wfP65gwQrjw,8082
 atomicshop/wrappers/ctyping/process_winapi.py,sha256=QcXL-ETtlSSkoT8F7pYle97ubGWsjYp8cx8HxkVMgAc,2762
 atomicshop/wrappers/factw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/wrappers/factw/fact_config.py,sha256=rHraVpYAzTdR5RD1nhXmj3I4fT-k44VxT3FS4hyvyX0,176
+atomicshop/wrappers/factw/fact_config.py,sha256=Cxxg46cAgsquoaJiHLEmGy9GxqXTQhO_53fP32KDQ78,276
 atomicshop/wrappers/factw/get_file_data.py,sha256=ChKC0OjgjFlNubZQBwcGhRO3L2pccc27RLRlAMIUix4,1641
-atomicshop/wrappers/factw/rest_file_object.py,sha256=_utxe0-hQNKwBFFP3cmsLKmGlhU0UuJo67SCRfQ2aAk,2433
-atomicshop/wrappers/factw/rest_firmware.py,sha256=k2YvgH7qi_-oBDutoRUiEJ-2N_we2XOguCSmuC7UNDk,9486
-atomicshop/wrappers/factw/rest_status.py,sha256=1LmMniq3r5joCNj1RG2BaDUfDwTbK8-9iitkfKB69Ec,646
+atomicshop/wrappers/factw/rest_binary_search.py,sha256=k0O-fmBiFBQzCCyTjXdpSDKuegJPDJgZuE3GEmKK448,824
+atomicshop/wrappers/factw/rest_file_object.py,sha256=4hk0XmwE1VVaiVoFTjnrRkmEQJPR3kWGEtj2ueex72Y,3216
+atomicshop/wrappers/factw/rest_firmware.py,sha256=aE3laaM5oZJntqxbf_UPBL1yb_8d1VvicGxybMzOCVY,20383
+atomicshop/wrappers/factw/rest_router.py,sha256=zrBDM66q9Q9BBuY8xFAL35IHmIOM5iPRuWFMn9lQ8QU,745
+atomicshop/wrappers/factw/rest_statistics.py,sha256=0no4yDZ5GSJbb8Hl8ZMyTahvNV1o7tilXJ9ifl7v4j4,651
+atomicshop/wrappers/factw/rest_status.py,sha256=iWpn6RpaQEKDavKTaTTsolCJ-HGzIEeNyQxVyMQRUYQ,639
 atomicshop/wrappers/loggingw/checks.py,sha256=AGFsTsLxHQd1yAraa5popqLaGO9VM0KpcPGuSLn5ptU,719
 atomicshop/wrappers/loggingw/formatters.py,sha256=mUtcJJfmhLNrwUVYShXTmdu40dBaJu4TS8FiuTXI7ys,7189
 atomicshop/wrappers/loggingw/handlers.py,sha256=qm5Fbu8eDmlstMduUe5nKUlJU5IazFkSnQizz8Qt2os,5479
@@ -165,8 +168,8 @@ atomicshop/wrappers/socketw/socket_server_tester.py,sha256=VfNthyBvgI5tL9v3Qprh4
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=aXBwlEIJhFT0-c4i8iNlFx2It9VpCEpsv--5Oqcpxao,11624
 atomicshop/wrappers/socketw/ssl_base.py,sha256=k4V3gwkbq10MvOH4btU4onLX2GNOsSfUAdcHmL1rpVE,2274
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=t3dtDEfN47CfYVi0CW6Kc2QHTEeZVyYhc57IYYh5nmA,826
-atomicshop-2.3.11.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.3.11.dist-info/METADATA,sha256=6ClmBaVnRAzJ9eeRfZOF2wj0VUbrVx4QqGCs6eoIJHA,9586
-atomicshop-2.3.11.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-atomicshop-2.3.11.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.3.11.dist-info/RECORD,,
+atomicshop-2.4.1.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.4.1.dist-info/METADATA,sha256=O2JGo-QiTkcZ4fi_FinqLRM_zdsGIgbOLUau2-l9JI8,9585
+atomicshop-2.4.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+atomicshop-2.4.1.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.4.1.dist-info/RECORD,,