atomicshop 2.16.14__py3-none-any.whl → 2.16.16__py3-none-any.whl

atomicshop/wrappers/mongodbw/mongodbw.py

@@ -1,6 +1,11 @@
+from typing import Union
+import datetime
+
 import pymongo
 
-from . import infrastructure
+from ...basics import dicts
+
+from . import mongo_infra
 
 
 """
@@ -9,7 +14,7 @@ These are good examples to get you started, but can't really cover all the use c
 """
 
 
-def connect(uri: str = infrastructure.MONGODB_DEFAULT_URI):
+def connect(uri: str = mongo_infra.MONGODB_DEFAULT_URI):
     """
     Connect to a MongoDB database.
     :param uri: str, the URI of the MongoDB database.
@@ -18,18 +23,23 @@ def connect(uri: str = infrastructure.MONGODB_DEFAULT_URI):
     return pymongo.MongoClient(uri)
 
 
-def add_list_of_dicts_to_mongo(
-        list_of_dicts: list,
+def index(
+        object_instance: Union[list[dict], dict],
         database_name: str,
         collection_name: str,
+        add_timestamp: bool = False,
+        convert_mixed_lists_to_strings: bool = False,
         mongo_client: pymongo.MongoClient = None,
         close_client: bool = False
 ):
     """
-    Add a list of dictionaries to a MongoDB collection.
-    :param list_of_dicts: list of dictionaries, the list of dictionaries to add to the collection.
+    Add a dictionary or list dictionaries to a MongoDB collection.
+    :param object_instance: list of dictionaries or dictionary to add to the collection.
     :param database_name: str, the name of the database.
     :param collection_name: str, the name of the collection.
+    :param add_timestamp: bool, if True, a current time timestamp will be added to the object.
+    :param convert_mixed_lists_to_strings: bool, if True, mixed lists or tuples when entries are strings and integers,
+        the integers will be converted to strings.
     :param mongo_client: pymongo.MongoClient, the connection object.
         If None, a new connection will be created to default URI.
     :param close_client: bool, if True, the connection will be closed after the operation.
@@ -37,28 +47,46 @@ def add_list_of_dicts_to_mongo(
     :return: None
     """
 
+    _is_object_list_of_dicts_or_dict(object_instance)
+
     if not mongo_client:
         mongo_client = connect()
+        close_client = True
 
     db = mongo_client[database_name]
     collection = db[collection_name]
 
-    collection.insert_many(list_of_dicts)
+    if convert_mixed_lists_to_strings:
+        object_instance = dicts.convert_int_to_str_in_mixed_lists(object_instance)
+
+    if add_timestamp:
+        timestamp = datetime.datetime.now()
+        if isinstance(object_instance, dict):
+            object_instance['timestamp'] = timestamp
+        elif isinstance(object_instance, list):
+            for doc in object_instance:
+                doc['timestamp'] = timestamp
+
+    if isinstance(object_instance, dict):
+        collection.insert_one(object_instance)
+    elif isinstance(object_instance, list):
+        collection.insert_many(object_instance)
 
     if close_client:
         mongo_client.close()
 
 
-def remove_list_of_dicts(
-        list_of_dicts: list,
+def delete(
+        object_instance: Union[list[dict], dict],
         database_name: str,
         collection_name: str,
         mongo_client: pymongo.MongoClient = None,
         close_client: bool = False
 ):
     """
-    Remove a list of dictionaries from a MongoDB collection.
-    :param list_of_dicts: list of dictionaries, the list of dictionaries to remove from the collection.
+    Remove a list of dictionaries or a dictionary from a MongoDB collection.
+
+    :param object_instance: list of dictionaries, the list of dictionaries to remove from the collection.
     :param database_name: str, the name of the database.
     :param collection_name: str, the name of the collection.
     :param mongo_client: pymongo.MongoClient, the connection object.
@@ -68,29 +96,74 @@ def remove_list_of_dicts(
     :return: None
     """
 
+    _is_object_list_of_dicts_or_dict(object_instance)
+
     if not mongo_client:
         mongo_client = connect()
+        close_client = True
 
     db = mongo_client[database_name]
     collection = db[collection_name]
 
-    for doc in list_of_dicts:
-        collection.delete_one(doc)
+    if isinstance(object_instance, dict):
+        collection.delete_one(object_instance)
+    elif isinstance(object_instance, list):
+        for doc in object_instance:
+            collection.delete_one(doc)
 
     if close_client:
         mongo_client.close()
 
 
-def overwrite_list_of_dicts(
-        list_of_dicts: list,
+def find(
         database_name: str,
         collection_name: str,
+        query: dict = None,
         mongo_client: pymongo.MongoClient = None,
         close_client: bool = False
 ):
     """
-    Overwrite a list of dictionaries in a MongoDB collection.
-    :param list_of_dicts: list of dictionaries, the list of dictionaries to overwrite in the collection.
+    Find entries in a MongoDB collection by query.
+    :param database_name: str, the name of the database.
+    :param collection_name: str, the name of the collection.
+    :param query: dict, the query to search for.
+        Example, search for all entries with column name 'name' equal to 'John':
+            query = {'name': 'John'}
+        Example, return all entries from collection:
+            query = None
+    :param mongo_client: pymongo.MongoClient, the connection object.
+        If None, a new connection will be created to default URI.
+    :param close_client: bool, if True, the connection will be closed after the operation.
+
+    :return: list of dictionaries, the list of entries that match the query.
+    """
+
+    if not mongo_client:
+        mongo_client = connect()
+        close_client = True
+
+    db = mongo_client[database_name]
+    collection = db[collection_name]
+
+    if query is None:
+        entries: list = list(collection.find())
+    else:
+        entries: list = list(collection.find(query))
+
+    if close_client:
+        mongo_client.close()
+
+    return entries
+
+
+def delete_all_entries_from_collection(
+        database_name: str,
+        collection_name: str,
+        mongo_client: pymongo.MongoClient = None,
+        close_client: bool = False
+):
+    """
+    Remove all entries from a MongoDB collection.
     :param database_name: str, the name of the database.
     :param collection_name: str, the name of the collection.
     :param mongo_client: pymongo.MongoClient, the connection object.
@@ -102,43 +175,120 @@ def overwrite_list_of_dicts(
 
     if not mongo_client:
         mongo_client = connect()
+        close_client = True
 
     db = mongo_client[database_name]
     collection = db[collection_name]
 
     collection.delete_many({})
-    collection.insert_many(list_of_dicts)
 
     if close_client:
         mongo_client.close()
 
 
-def get_all_entries_from_collection(
+def overwrite_collection(
+        object_instance: list,
         database_name: str,
         collection_name: str,
+        add_timestamp: bool = False,
+        convert_mixed_lists_to_strings: bool = False,
         mongo_client: pymongo.MongoClient = None,
         close_client: bool = False
 ):
     """
-    Get all entries from a MongoDB collection.
+    Overwrite a MongoDB collection with list of dicts or a dict.
+    :param object_instance: list of dictionaries, the list of dictionaries to overwrite in the collection.
     :param database_name: str, the name of the database.
     :param collection_name: str, the name of the collection.
+    :param add_timestamp: bool, if True, a current time timestamp will be added to the object.
+    :param convert_mixed_lists_to_strings: bool, if True, mixed lists or tuples when entries are strings and integers,
+        the integers will be converted to strings.
+    :param mongo_client: pymongo.MongoClient, the connection object.
+        If None, a new connection will be created to default URI.
+    :param close_client: bool, if True, the connection will be closed after the operation.
+
+    :return: None
+    """
+
+    _is_object_list_of_dicts_or_dict(object_instance)
+
+    if not mongo_client:
+        mongo_client = connect()
+        close_client = True
+
+    delete_all_entries_from_collection(
+        database_name=database_name, collection_name=collection_name,
+        mongo_client=mongo_client
+    )
+
+    index(
+        object_instance=object_instance,
+        database_name=database_name, collection_name=collection_name,
+        add_timestamp=add_timestamp, convert_mixed_lists_to_strings=convert_mixed_lists_to_strings,
+        mongo_client=mongo_client, close_client=close_client)
+
+
+def _is_object_list_of_dicts_or_dict(
+        object_instance: Union[list[dict], dict]
+):
+    if isinstance(object_instance, dict):
+        return True
+    elif isinstance(object_instance, list):
+        if object_instance and isinstance(object_instance[0], dict):
+            return True
+        else:
+            raise ValueError("List must contain dictionaries.")
+    else:
+        raise ValueError("Object must be a dictionary or a list of dictionaries.")
+
+
+def get_stats_db(
+        database_name: str,
+        mongo_client: pymongo.MongoClient = None,
+        close_client: bool = False
+):
+    """
+    Get the stats of a MongoDB database.
+
+    :param database_name: str, the name of the database.
     :param mongo_client: pymongo.MongoClient, the connection object.
         If None, a new connection will be created to default URI.
     :param close_client: bool, if True, the connection will be closed after the operation.
 
-    :return: list of dictionaries, the list of entries from the collection.
+    :return: dict, the stats of the collection.
     """
 
     if not mongo_client:
         mongo_client = connect()
+        close_client = True
 
     db = mongo_client[database_name]
-    collection = db[collection_name]
 
-    entries = list(collection.find())
+    stats = db.command("dbStats")
 
     if close_client:
         mongo_client.close()
 
-    return entries
+    return stats
+
+
+def get_stats_db_size(
+        database_name: str,
+        mongo_client: pymongo.MongoClient = None,
+        close_client: bool = False
+):
+    """
+    Get the size of a MongoDB database in bytes.
+
+    :param database_name: str, the name of the database.
+    :param mongo_client: pymongo.MongoClient, the connection object.
+        If None, a new connection will be created to default URI.
+    :param close_client: bool, if True, the connection will be closed after the operation.
+
+    :return: int, the size of the database in bytes.
+    """
+
+    stats = get_stats_db(
+        database_name=database_name, mongo_client=mongo_client, close_client=close_client)
+
+    return stats['dataSize']

atomicshop/wrappers/pywin32w/cert_store.py

@@ -0,0 +1,89 @@
+from typing import Literal
+import win32crypt as wcrypt
+
+from ...print_api import print_api
+from ... import certificates
+
+
+# lpszStoreProvider
+CERT_STORE_PROV_SYSTEM = 0x0000000A
+# dwFlags
+CERT_SYSTEM_STORE_LOCAL_MACHINE = 0x00020000
+CERT_SYSTEM_STORE_CURRENT_USER = 0x00010000
+CERT_CLOSE_STORE_FORCE_FLAG = 0x00000001
+CRYPT_STRING_BASE64HEADER = 0x00000000
+X509_ASN_ENCODING = 0x00000001
+CERT_STORE_ADD_REPLACE_EXISTING = 3
+
+
+STORE_LOCATION_TO_CERT_SYSTEM_STORE: dict = {
+    "ROOT": CERT_SYSTEM_STORE_LOCAL_MACHINE,
+    "CA": CERT_SYSTEM_STORE_LOCAL_MACHINE,
+    "MY": CERT_SYSTEM_STORE_CURRENT_USER
+}
+
+
+def delete_certificate_by_issuer_name(
+        issuer_name: str,
+        store_location: Literal[
+            "ROOT",
+            "CA",
+            "MY"] = "ROOT",
+        print_kwargs: dict = None
+):
+    """
+    NEED ADMIN RIGHTS.
+    The function will remove all certificates with the specified issuer name.
+    There can be several certificates with this name.
+
+    :param issuer_name: string, issuer name to search for.
+    :param store_location: string, store location to search in. Default is "ROOT".
+    :param print_kwargs: dict, print_api kwargs.
+    """
+
+    store = wcrypt.CertOpenStore(
+        CERT_STORE_PROV_SYSTEM, 0, None, STORE_LOCATION_TO_CERT_SYSTEM_STORE[store_location], store_location)
+
+    for cert in store.CertEnumCertificatesInStore():
+        # Certificate properties.
+        # cert.CertEnumCertificateContextProperties()
+        subject_string: str = wcrypt.CertNameToStr(cert.Subject)
+        if subject_string == issuer_name:
+            # Remove the certificate.
+            cert.CertDeleteCertificateFromStore()
+            print_api(f"Removed the Certificate with issuer: {issuer_name}", **(print_kwargs or {}))
+
+    # There is an exception about store close.
+    # store.CertCloseStore()
+
+
+def install_certificate_file(
+        file_path: str,
+        store_location: Literal[
+            "ROOT", "CA", "MY"] = "ROOT",
+        print_kwargs: dict = None
+):
+    """
+    NEED ADMIN RIGHTS.
+    The function will install the certificate from the file to the specified store location.
+
+    :param file_path: string, full file path to the certificate file.
+    :param store_location: string, store location to install the certificate. Default is "ROOT".
+    :param print_kwargs: dict, print_api kwargs.
+    """
+
+    with open(file_path, 'r') as f:
+        certificate_string = f.read()
+
+    certificate_pem = certificates.get_pem_certificate_from_string(certificate_string)
+
+    certificate_bytes = wcrypt.CryptStringToBinary(certificate_pem, CRYPT_STRING_BASE64HEADER)[0]
+
+    store = wcrypt.CertOpenStore(
+        CERT_STORE_PROV_SYSTEM, 0, None, STORE_LOCATION_TO_CERT_SYSTEM_STORE[store_location], store_location)
+
+    store.CertAddEncodedCertificateToStore(X509_ASN_ENCODING, certificate_bytes, CERT_STORE_ADD_REPLACE_EXISTING)
+    store.CertCloseStore(CERT_CLOSE_STORE_FORCE_FLAG)
+
+    message = f"Certificate installed to the store: [{store_location}] from file: [{file_path}]"
+    print_api(message, **(print_kwargs or {}))

atomicshop/wrappers/socketw/socket_server_tester.py

@@ -54,7 +54,11 @@ def execute_test(config_static):
     config = config_importer.config['config']
 
     # SocketClient is working with 'network' logger by default, so we will initialize it.
-    loggingw.get_logger_with_stream_handler("network")
+    loggingw.create_logger(
+        logger_name="network",
+        add_stream=True,
+        formatter_streamhandler='DEFAULT'
+    )
 
     # Get all the files in requests folder recursively.
     request_file_list = filesystem.get_paths_from_directory(config['requests_directory'], get_file=True)

atomicshop/wrappers/socketw/socket_wrapper.py

@@ -1,10 +1,13 @@
 import threading
 import select
 from typing import Literal, Union
+from pathlib import Path
 
 from ..psutilw import networks
+from ..certauthw import certauthw
 from ...script_as_string_processor import ScriptAsStringProcessor
-from ... import queues, filesystem
+from ...permissions import permissions
+from ... import queues, filesystem, certificates
 from ...basics import booleans
 from ...print_api import print_api
 
@@ -30,6 +33,9 @@ class SocketWrapper:
             forwarding_dns_service_ipv4_list___only_for_localhost: list = None,
             ca_certificate_name: str = None,
             ca_certificate_filepath: str = None,
+            ca_certificate_crt_filepath: str = None,
+            install_ca_certificate_to_root_store: bool = False,
+            uninstall_unused_ca_certificates_with_ca_certificate_name: bool = False,
             default_server_certificate_usage: bool = False,
             default_server_certificate_name: str = None,
             default_certificate_domain_list: list = None,
@@ -68,7 +74,13 @@ class SocketWrapper:
             Example: '0.0.0.0'. For all interfaces.
         :param listening_port_list: list, of ports that will be listened on.
         :param ca_certificate_name: CA certificate name.
-        :param ca_certificate_filepath: CA certificate file path.
+        :param ca_certificate_filepath: CA certificate file path with '.pem' extension.
+        :param ca_certificate_crt_filepath: CA certificate file path with '.crt' extension.
+            This file will be created from the PEM file 'ca_certificate_filepath' for manual installation.
+        :param install_ca_certificate_to_root_store: boolean, if True, CA certificate will be installed
+            to the root store.
+        :param uninstall_unused_ca_certificates_with_ca_certificate_name: boolean, if True, unused CA certificates
+            with provided 'ca_certificate_name' will be uninstalled.
         :param default_server_certificate_usage: boolean, if True, default server certificate will be used
             for each incoming socket.
         :param sni_custom_callback_function: callable, custom callback function that will be executed when
@@ -150,6 +162,10 @@ class SocketWrapper:
         self.listening_port_list: list[int] = listening_port_list
         self.ca_certificate_name: str = ca_certificate_name
         self.ca_certificate_filepath: str = ca_certificate_filepath
+        self.ca_certificate_crt_filepath: str = ca_certificate_crt_filepath
+        self.install_ca_certificate_to_root_store: bool = install_ca_certificate_to_root_store
+        self.uninstall_unused_ca_certificates_with_ca_certificate_name: bool = \
+            uninstall_unused_ca_certificates_with_ca_certificate_name
         self.default_server_certificate_usage: bool = default_server_certificate_usage
         self.default_server_certificate_name: str = default_server_certificate_name
         self.default_certificate_domain_list: list = default_certificate_domain_list
@@ -270,6 +286,59 @@ class SocketWrapper:
                 error_messages.append(f"Port [{port}] is already in use by process: {process_info}")
             raise SocketWrapperPortInUseError("\n".join(error_messages))
 
+        if not filesystem.is_file_exists(file_path=self.ca_certificate_filepath):
+            # Initialize CertAuthWrapper.
+            ca_certificate_directory: str = str(Path(self.ca_certificate_filepath).parent)
+            certauth_wrapper = certauthw.CertAuthWrapper(
+                ca_certificate_name=self.ca_certificate_name,
+                ca_certificate_filepath=self.ca_certificate_filepath,
+                server_certificate_directory=ca_certificate_directory
+            )
+
+            # Create CA certificate if it doesn't exist.
+            certauth_wrapper.create_use_ca_certificate()
+
+            certificates.write_crt_certificate_file_in_pem_format_from_pem_file(
+                pem_file_path=self.ca_certificate_filepath,
+                crt_file_path=self.ca_certificate_crt_filepath)
+
+        if self.install_ca_certificate_to_root_store:
+            if not self.ca_certificate_filepath:
+                message = "You set [install_ca_certificate_to_root_store = True],\n" \
+                          "But you didn't set [ca_certificate_filepath]."
+                raise SocketWrapperConfigurationValuesError(message)
+
+            # Before installation check if there are any unused certificates with the same name.
+            if self.uninstall_unused_ca_certificates_with_ca_certificate_name:
+                # Check how many certificates with our ca certificate name are installed.
+                is_installed_by_name, certificate_list_by_name = certificates.is_certificate_in_store(
+                    issuer_name=self.ca_certificate_name)
+                # If there is more than one certificate with the same name, delete them all.
+                if is_installed_by_name and len(certificate_list_by_name) > 1:
+                    certificates.delete_certificate_by_issuer_name(self.ca_certificate_name)
+                # If there is only one certificate with the same name, check if it is the same certificate.
+                elif is_installed_by_name and len(certificate_list_by_name) == 1:
+                    is_installed_by_file, certificate_list_by_file = certificates.is_certificate_in_store(
+                        certificate=self.ca_certificate_filepath, by_cert_thumbprint=True, by_cert_issuer=True)
+                    # If the certificate is not the same, delete it.
+                    if not is_installed_by_file:
+                        if not permissions.is_admin():
+                            raise SocketWrapperConfigurationValuesError(
+                                "You need to run the script with admin rights to uninstall the unused certificates.")
+                        certificates.delete_certificate_by_issuer_name(
+                            self.ca_certificate_name, store_location="ROOT", print_kwargs={'logger': self.logger})
+
+            if self.install_ca_certificate_to_root_store:
+                # Install CA certificate to the root store if it is not installed.
+                is_installed_by_file, certificate_list_by_file = certificates.is_certificate_in_store(
+                    certificate=self.ca_certificate_filepath, by_cert_thumbprint=True, by_cert_issuer=True)
+                if not is_installed_by_file:
+                    if not permissions.is_admin():
+                        raise SocketWrapperConfigurationValuesError(
+                            "You need to run the script with admin rights to install the CA certificate.")
+                    certificates.install_certificate_file(
+                        self.ca_certificate_filepath, store_location="ROOT", print_kwargs={'logger': self.logger})
+
     # Creating listening sockets.
     def create_socket_ipv4_tcp(self, ip_address: str, port: int):
         self.sni_execute_extended = True

atomicshop/wrappers/socketw/ssl_base.py

@@ -60,7 +60,7 @@ def is_tls(client_socket) -> Optional[Tuple[str, str]]:
     }
 
     # Get the tuple of the type and version as strings.
-    tls_content_and_version_tuple: tuple =\
+    tls_content_and_version_tuple: tuple = \
         content_type_map.get(content_type), version_map.get((version_major, version_minor))
 
     # If both parts of the tuple are not None, return the protocol type.

{atomicshop-2.16.14.dist-info → atomicshop-2.16.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atomicshop
-Version: 2.16.14
+Version: 2.16.16
 Summary: Atomic functions and classes to make developer life easier
 Author: Denis Kras
 License: MIT License
@@ -38,7 +38,6 @@ Requires-Dist: cryptography
 Requires-Dist: dnslib
 Requires-Dist: dnspython
 Requires-Dist: docker
-Requires-Dist: elasticsearch
 Requires-Dist: numpy
 Requires-Dist: olefile
 Requires-Dist: openpyxl