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

atomicshop/mitm/config_static.py

@@ -123,6 +123,7 @@ class LogRec:
 
 @dataclass
 class Certificates:
+    enable_sslkeylogfile_env_to_client_ssl_context: bool
     install_ca_certificate_to_root_store: bool
     uninstall_unused_ca_certificates_with_mitm_ca_name: bool
 

atomicshop/mitm/connection_thread_worker.py

@@ -210,12 +210,15 @@ def thread_worker_main(
         # config['tcp']['forwarding_dns_service_ipv4_list___only_for_localhost']
         if client_message.client_ip in base.THIS_DEVICE_IP_LIST:
             service_client_instance = socket_client.SocketClient(
-                service_name=client_message.server_name, service_port=client_message.destination_port,
+                service_name=client_message.server_name,
+                service_port=client_message.destination_port,
                 tls=is_tls,
                 dns_servers_list=(
                     config_static.TCPServer.forwarding_dns_service_ipv4_list___only_for_localhost),
                 logger=network_logger,
-                custom_pem_client_certificate_file_path=custom_client_pem_certificate_path
+                custom_pem_client_certificate_file_path=custom_client_pem_certificate_path,
+                enable_sslkeylogfile_env_to_client_ssl_context=(
+                    config_static.Certificates.enable_sslkeylogfile_env_to_client_ssl_context)
             )
         # If we're not on localhost, then connect to domain directly.
         else:
@@ -224,7 +227,9 @@ def thread_worker_main(
                 service_port=client_message.destination_port,
                 tls=is_tls,
                 logger=network_logger,
-                custom_pem_client_certificate_file_path=custom_client_pem_certificate_path
+                custom_pem_client_certificate_file_path=custom_client_pem_certificate_path,
+                enable_sslkeylogfile_env_to_client_ssl_context=(
+                    config_static.Certificates.enable_sslkeylogfile_env_to_client_ssl_context)
             )
 
         return service_client_instance

atomicshop/wrappers/socketw/creator.py

@@ -1,3 +1,4 @@
+import os
 import socket
 import ssl
 
@@ -33,8 +34,31 @@ def create_ssl_context_for_server():
     # return ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
 
 
-def create_ssl_context_for_client():
-    return ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
+def create_ssl_context_for_client(
+        enable_sslkeylogfile_env_to_client_ssl_context: bool = False
+) -> ssl.SSLContext:
+    """
+    This function creates the SSL context for the client.
+    The SSL context is created with the "PROTOCOL_TLS_CLIENT" protocol.
+
+    :param enable_sslkeylogfile_env_to_client_ssl_context: boolean, enables the SSLKEYLOGFILE environment variable
+        to the SSL context. Default is False.
+        if True, SSLKEYLOGFILE will be added to SSL context with:
+        ssl_context.keylog_filename = os.environ.get('SSLKEYLOGFILE')
+        This is useful for debugging SSL/TLS connections with WireShark.
+        Since WireShark also uses this environment variable to read the key log file and apply to the SSL/TLS
+        connections, so you can see the decrypted traffic.
+
+    :return: ssl.SSLContext
+    """
+    ssl_context: ssl.SSLContext = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT)
+
+    if enable_sslkeylogfile_env_to_client_ssl_context:
+        ssl_key_logfile = os.environ.get('SSLKEYLOGFILE')
+        if ssl_key_logfile:
+            ssl_context.keylog_filename = ssl_key_logfile
+
+    return ssl_context
 
 
 def set_client_ssl_context_ca_default_certs(ssl_context):
@@ -204,7 +228,8 @@ def set_listen_on_socket(socket_object, **kwargs):
 def wrap_socket_with_ssl_context_client___default_certs___ignore_verification(
         socket_object,
         server_hostname: str = None,
-        custom_pem_client_certificate_file_path: str = None
+        custom_pem_client_certificate_file_path: str = None,
+        enable_sslkeylogfile_env_to_client_ssl_context: bool = False
 ):
     """
     This function is a preset for wrapping the socket with SSL context for the client.
@@ -214,8 +239,11 @@ def wrap_socket_with_ssl_context_client___default_certs___ignore_verification(
     :param server_hostname: string, hostname of the server. Default is None.
     :param custom_pem_client_certificate_file_path: string, full file path for the client certificate PWM file.
         Default is None.
+    :param enable_sslkeylogfile_env_to_client_ssl_context: boolean, enables the SSLKEYLOGFILE environment variable
+        to the SSL context. Default is False.
     """
-    ssl_context: ssl.SSLContext = create_ssl_context_for_client()
+    ssl_context: ssl.SSLContext = create_ssl_context_for_client(
+        enable_sslkeylogfile_env_to_client_ssl_context=enable_sslkeylogfile_env_to_client_ssl_context)
     set_client_ssl_context_ca_default_certs(ssl_context)
     set_client_ssl_context_certificate_verification_ignore(ssl_context)
 

atomicshop/wrappers/socketw/sni.py

@@ -54,6 +54,7 @@ class SNISetup:
         self.default_server_certificate_name = default_server_certificate_name
         self.default_server_certificate_directory = default_server_certificate_directory
         self.default_certificate_domain_list = default_certificate_domain_list
+        self.enable_sslkeylogfile_to_ssl_context: bool = enable_sslkeylogfile_to_ssl_context
         self.sni_custom_callback_function: callable = sni_custom_callback_function
         self.sni_use_default_callback_function: bool = sni_use_default_callback_function
         self.sni_use_default_callback_function_extended: bool = sni_use_default_callback_function_extended

atomicshop/wrappers/socketw/socket_client.py

@@ -30,7 +30,8 @@ class SocketClient:
             connection_ip=None,
             dns_servers_list=None,
             logger: logging.Logger = None,
-            custom_pem_client_certificate_file_path: str = None
+            custom_pem_client_certificate_file_path: str = None,
+            enable_sslkeylogfile_env_to_client_ssl_context: bool = False
     ):
         """
         If you have a certificate for domain, but not for the IPv4 address, the SSL Socket context can be created for
@@ -50,6 +51,13 @@ class SocketClient:
         :param logger: (Optional) Logger object. If not provided, the default logger will be used.
         :param custom_pem_client_certificate_file_path: (Optional) If specified, the SSL Socket will be created with
             custom client certificate. The path to the file with the certificate should be provided.
+        :param enable_sslkeylogfile_env_to_client_ssl_context: boolean, enables the SSLKEYLOGFILE environment variable
+            to the SSL context. Default is False.
+            if True, SSLKEYLOGFILE will be added to SSL context with:
+            ssl_context.keylog_filename = os.environ.get('SSLKEYLOGFILE')
+            This is useful for debugging SSL/TLS connections with WireShark.
+            Since WireShark also uses this environment variable to read the key log file and apply to the SSL/TLS
+            connections, so you can see the decrypted traffic.
 
         If both 'connection_ip' and 'dns_servers_list' specified, ValueException with raise.
         """
@@ -59,6 +67,7 @@ class SocketClient:
         self.connection_ip = connection_ip
         self.dns_servers_list = dns_servers_list
         self.custom_pem_client_certificate_file_path: str = custom_pem_client_certificate_file_path
+        self.enable_sslkeylogfile_env_to_client_ssl_context: bool = enable_sslkeylogfile_env_to_client_ssl_context
 
         if logger:
             # Create child logger for the provided logger with the module's name.
@@ -91,7 +100,9 @@ class SocketClient:
             print_api.print_api(log_message, logger=self.logger, logger_method='info')
             socket_object = creator.create_socket_ipv4_tcp()
             return creator.wrap_socket_with_ssl_context_client___default_certs___ignore_verification(
-                socket_object, self.service_name, self.custom_pem_client_certificate_file_path)
+                socket_object, self.service_name, self.custom_pem_client_certificate_file_path,
+                enable_sslkeylogfile_env_to_client_ssl_context=self.enable_sslkeylogfile_env_to_client_ssl_context
+            )
 
     def service_connection(
             self

{atomicshop-2.17.2.dist-info → atomicshop-2.17.3.dist-info}/METADATA

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

{atomicshop-2.17.2.dist-info → atomicshop-2.17.3.dist-info}/RECORD

@@ -1,4 +1,4 @@
-atomicshop/__init__.py,sha256=fZxhx9GigOSbMFUY_dyKq_MeAvWRB0kkmUwCZ3ILy2A,123
+atomicshop/__init__.py,sha256=T9jtW2aWDvJvFYaGUUorjlEM5yR1Lx48uobqDYGwsHY,123
 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
@@ -125,9 +125,9 @@ atomicshop/file_io/tomls.py,sha256=ol8EvQPf9sryTmZUf1v55BYSUQ6ml7HVVBHpNKbsIlA,9
 atomicshop/file_io/xlsxs.py,sha256=v_dyg9GD4LqgWi6wA1QuWRZ8zG4ZwB6Dz52ytdcmmmI,2184
 atomicshop/file_io/xmls.py,sha256=zh3SuK-dNaFq2NDNhx6ivcf4GYCfGM8M10PcEwDSpxk,2104
 atomicshop/mitm/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atomicshop/mitm/config_static.py,sha256=ROAtbibSWSsF3BraUbhu-QO3MPIFqYY5KUKgsQbiSkk,7813
+atomicshop/mitm/config_static.py,sha256=r6M4FJVBr9jGIXmjcOk2KBHvCPelWcbZCQrRh3-G26k,7871
 atomicshop/mitm/config_toml_editor.py,sha256=2p1CMcktWRR_NW-SmyDwylu63ad5e0-w1QPMa8ZLDBw,1635
-atomicshop/mitm/connection_thread_worker.py,sha256=EtEp6aymfQ-btZzeZDmxLJdIortB4Gf5MOaHwEFSShI,21095
+atomicshop/mitm/connection_thread_worker.py,sha256=nbCQNQwJFoBnXTmIXvqpL6Jq2Q28uTn4FRaoCZZdrHA,21438
 atomicshop/mitm/import_config.py,sha256=0Ij14aISTllTOiWYJpIUMOWobQqGofD6uafui5uWllE,9272
 atomicshop/mitm/initialize_engines.py,sha256=NWz0yBErSrYBn0xWkJDBcHStBJ-kcsv9VtorcSP9x5M,8258
 atomicshop/mitm/message.py,sha256=URR5JKSuAT8XmGIkyprEjlPW2GW4ef_gfUz_GgcFseE,2184
@@ -305,22 +305,22 @@ atomicshop/wrappers/socketw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMp
 atomicshop/wrappers/socketw/accepter.py,sha256=hZZKVYlF3LOHQJsSIEKXZUf6QXXWm-AtqXZevvaYigE,1732
 atomicshop/wrappers/socketw/base.py,sha256=DV6BWao9kiLAWimhVDKGEi3ISVaWk5iPHXtBHrO3uwc,2264
 atomicshop/wrappers/socketw/certificator.py,sha256=mtWPJ_ew3OSwt0-1W4jaoco1VIY4NRCrMv3mDUxb_Cc,12418
-atomicshop/wrappers/socketw/creator.py,sha256=OLcd7FyUk_k8iyoL-xYnCnNmolPSgio6OeQXth7NdLg,11414
+atomicshop/wrappers/socketw/creator.py,sha256=zMWLsOF07vX-xQZR720LeHQVndUT8q-ytdCrKF5tt9I,12835
 atomicshop/wrappers/socketw/dns_server.py,sha256=RklzINNuoMQn4PGGQEI5hiAldprbVwwvikY6u9X-jTY,49067
 atomicshop/wrappers/socketw/exception_wrapper.py,sha256=B-X5SHLSUIWToihH2MKnOB1F4A81_X0DpLLfnYKYbEc,7067
 atomicshop/wrappers/socketw/get_process.py,sha256=aJC-_qFUv3NgWCSUzDI72E4z8_-VTZE9NVZ0CwUoNlM,5698
 atomicshop/wrappers/socketw/receiver.py,sha256=-QtKK0T_lmoAIypTYaIKOD3pgB1npWGPxcVEN37y_gk,10060
 atomicshop/wrappers/socketw/sender.py,sha256=gwSzF51QD5paeeFav6fpbQpO8KgBO5lNztHYQyN5id0,4959
-atomicshop/wrappers/socketw/sni.py,sha256=Nc8WMZZR21o5GXILQLVWbf7OzNPXAfE8trJY153e9Qk,17591
-atomicshop/wrappers/socketw/socket_client.py,sha256=YUlwbasxYQqz1xUlPWxwEnSDSCYKGdxWb2CFAogefr8,21131
+atomicshop/wrappers/socketw/sni.py,sha256=28xpmGawMvO2wpeqpBPtxpX6cX661_CXqPElRAyLj-0,17685
+atomicshop/wrappers/socketw/socket_client.py,sha256=qwEV4HSMiROPk5VOY6kj_3k00tCIN8c0rZh3fjpSBno,22027
 atomicshop/wrappers/socketw/socket_server_tester.py,sha256=Qobmh4XV8ZxLUaw-eW4ESKAbeSLecCKn2OWFzMhadk0,6420
 atomicshop/wrappers/socketw/socket_wrapper.py,sha256=WtylpezgIIBuz-A6PfM0hO1sm9Exd4j3qhDXcFc74-E,35567
 atomicshop/wrappers/socketw/ssl_base.py,sha256=kmiif84kMhBr5yjQW17p935sfjR5JKG0LxIwBA4iVvU,2275
 atomicshop/wrappers/socketw/statistics_csv.py,sha256=SDYI1cN0oaapvPeLxSXiJrelTy6xbZl-bopR0jAjVGE,3149
 atomicshop/wrappers/winregw/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 atomicshop/wrappers/winregw/winreg_network.py,sha256=zZQfps-CdODQaTUADbHAwKHr5RUg7BLafnKWBbKaLN4,8728
-atomicshop-2.17.2.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
-atomicshop-2.17.2.dist-info/METADATA,sha256=zpoROqa6g64vizJD01vVwLmwAaztvWVl_nmBKaceXL4,10499
-atomicshop-2.17.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-atomicshop-2.17.2.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
-atomicshop-2.17.2.dist-info/RECORD,,
+atomicshop-2.17.3.dist-info/LICENSE.txt,sha256=lLU7EYycfYcK2NR_1gfnhnRC8b8ccOTElACYplgZN88,1094
+atomicshop-2.17.3.dist-info/METADATA,sha256=LHsnD_4t56XniePIJ4iTVrrCfWOpqDoLxXG3kxNXvJw,10499
+atomicshop-2.17.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+atomicshop-2.17.3.dist-info/top_level.txt,sha256=EgKJB-7xcrAPeqTRF2laD_Np2gNGYkJkd4OyXqpJphA,11
+atomicshop-2.17.3.dist-info/RECORD,,