osbot-utils 1.29.0__py3-none-any.whl → 1.31.0__py3-none-any.whl

osbot_utils/helpers/Hashicorp_Secrets.py

@@ -0,0 +1,101 @@
+from osbot_utils.utils.Env                  import get_env
+from osbot_utils.base_classes.Type_Safe     import Type_Safe
+from osbot_utils.utils.Lists                import list_index_by
+from osbot_utils.utils.Misc                 import list_set
+
+ENV_VAR__HCP_ACCESS_TOKEN    = 'HCP_ACCESS_TOKEN'
+ENV_VAR__HCP_APP_NAME        = 'HCP_APP_NAME'
+ENV_VAR__HCP_CLIENT_ID       = 'HCP_CLIENT_ID'
+ENV_VAR__HCP_CLIENT_SECRET   = 'HCP_CLIENT_SECRET'
+ENV_VAR__HCP_ORGANIZATION_ID = 'HCP_ORGANIZATION_ID'
+ENV_VAR__HCP_PROJECT_ID      = 'HCP_PROJECT_ID'
+
+class Hashicorp_Secrets(Type_Safe):
+
+    # helper methods
+    def hcp__auth_details(self):
+        client_id     = get_env(ENV_VAR__HCP_CLIENT_ID)
+        client_secret = get_env(ENV_VAR__HCP_CLIENT_SECRET)
+        return client_id, client_secret
+
+    def hcp__access_token(self):                                                                    # todo: refactor to remove dependency on requests package (which is not part of the OSBOt_utils project)
+        import requests
+
+        access_token = get_env(ENV_VAR__HCP_ACCESS_TOKEN)                   # todo: add better way to detect when the access token as expired
+        if not access_token:
+
+            client_id, client_secret = self.hcp__auth_details()
+            token_url               = 'https://auth.idp.hashicorp.com/oauth2/token'
+            payload                 = { 'client_id'     : client_id                     ,
+                                        'client_secret' : client_secret                 ,
+                                        'grant_type'    : 'client_credentials'          ,
+                                        'audience'      : 'https://api.hashicorp.cloud' }
+
+            response = requests.post(token_url, data=payload)                                       # todo: refactor into requests_post method
+            if response.status_code == 200:
+                access_token = response.json().get('access_token')
+        return access_token
+
+    def hcp__enabled(self):
+        if self.hcp__organization_id():
+            if self.hcp__project_id():
+                return True
+        return False
+
+    def hcp__app_name(self):
+        return get_env(ENV_VAR__HCP_APP_NAME)
+
+    def hcp__organization_id(self):
+        return get_env(ENV_VAR__HCP_ORGANIZATION_ID)
+
+    def hcp__project_id(self):
+        return get_env(ENV_VAR__HCP_PROJECT_ID)
+
+    def requests_get(self, path, data_field=None):
+        import requests
+
+        organization_id = self.hcp__organization_id()
+        project_id      = self.hcp__project_id()
+        headers         = {'Authorization': f"Bearer  { self.hcp__access_token()}" }
+        url             = f"https://api.cloud.hashicorp.com/secrets/2023-06-13/organizations/{organization_id}/projects/{project_id}/{path}"
+        response = requests.get(url, headers=headers)
+        if response.status_code == 200:
+            json_data = response.json()
+            if data_field is None:
+                data_field = path
+            return json_data.get(data_field)
+        return {}
+
+    # API methods
+    def app_secrets(self, app_name=None):
+        if app_name is None:
+            app_name = self.hcp__app_name()
+        path_secrets = f'apps/{app_name}/secrets'
+        app_secrets  = self.requests_get(path_secrets, 'secrets')
+        return app_secrets
+
+    def app_secrets_open(self, app_name=None):
+        if app_name is None:
+            app_name = self.hcp__app_name()
+        path_secrets = f'apps/{app_name}/open'
+        app_secrets  = self.requests_get(path_secrets, 'secrets')
+        return app_secrets
+
+    def app_secrets_names(self, app_name=None):
+        app_secrets = self.app_secrets(app_name)
+        return list_set(list_index_by(app_secrets, 'name'))
+
+    def app_secrets_values(self, app_name=None):
+        secrets_values = {}
+        app_secrets    = self.app_secrets_open(app_name)
+        for app_secret in app_secrets:
+            secret_name                 = app_secret.get('name'       )
+            secret_value                = app_secret.get('version', {}).get('value')
+            secrets_values[secret_name] = secret_value
+        return secrets_values
+
+
+
+    def apps(self):
+        return self.requests_get('apps')
+

osbot_utils/helpers/trace/Trace_Call.py

@@ -11,8 +11,8 @@ from osbot_utils.helpers.trace.Trace_Call__View_Model       import Trace_Call__V
 
 
 def trace_calls(title         = None , print_traces = True , show_locals    = False, source_code          = False ,
-                ignore        = None , include      = None , show_path      = False, duration_bigger_than = 0     , trace_depth=0,
-                max_string    = None , show_types   = False, show_duration  = False ,# show_caller    = False     ,         # todo: add back when show_caller is working again
+                ignore        = None , include      = None , show_path      = False, duration_bigger_than = 0     ,
+                trace_depth   = 0    , max_string   = None , show_types     = False, show_duration        = False , # show_caller    = False     ,         # todo: add back when show_caller is working again
                 show_class    = False, contains     = None , show_internals = False, enabled              = True  ,
                 extra_data    = False, show_lines   = False, print_lines    = False, show_types_padding   = None  , duration_padding=None):
     def decorator(func):

osbot_utils/utils/Env.py

@@ -6,14 +6,28 @@ from osbot_utils.utils.Files    import all_parent_folders, file_exists
 from osbot_utils.utils.Misc     import list_set
 from osbot_utils.utils.Str      import strip_quotes
 
-def env__home_root():
+
+def env__home():
+    return get_env('HOME', '')
+
+def env__home__is__root():
     return os.getenv('HOME') == '/root'
 
-def env__terminal_xterm():
+def env__old_pwd():
+    return get_env('OLDPWD', '')
+
+def env__pwd():
+    return get_env('PWD', '')
+
+def env__old_pwd__remove(value):
+    return value.replace(env__old_pwd(), '')
+
+def env__terminal__is__xterm():
     return os.getenv('TERM') == 'xterm'
 
-def env__not_terminal_xterm():
-    return not env__terminal_xterm()
+def env__terminal__is_not__xterm():
+    return not env__terminal__is__xterm()
+
 
 def platform_darwin():
     return platform == 'darwin'
@@ -21,6 +35,10 @@ def platform_darwin():
 def env_value(var_name):
     return env_vars().get(var_name, None)
 
+def env_var_set(var_name):
+    value = os.getenv(var_name)
+    return value is not None and value != ''
+
 def env_vars_list():
     return list_set(env_vars())
 
@@ -109,6 +127,6 @@ def unload_dotenv(dotenv_path=None):
                 env_unload_from_file(env_path)                      # Process it
                 break                                               # Stop after unloading the first .env file
 
-
-env_load = load_dotenv
-get_env  = os.getenv
+is_env_var_set = env_var_set
+env_load       = load_dotenv
+get_env        = os.getenv

osbot_utils/utils/Files.py

@@ -340,6 +340,8 @@ class Files:
     def parent_folder_combine(file, path):
         return Files.path_combine(os.path.dirname(file),path)
 
+
+
     @staticmethod
     def pickle_save_to_file(object_to_save, path=None):
         path = path or temp_file(extension=".pickle")
@@ -491,12 +493,26 @@ def folders_names_in_folder(target):
     folders = folders_in_folder(target)
     return folders_names(folders)
 
+def path_combine_safe(base_path, file_location, raise_exception=False):                                  # handle possible directory transversal attacks
+    full_path            = os.path.join(base_path, file_location)                                       # Combine and normalize paths
+    normalised_base_path = os.path.normpath(base_path)
+    normalised_full_path = os.path.normpath(full_path)
+
+    if os.path.commonpath([normalised_base_path, normalised_full_path]) == normalised_base_path:        # Check for directory traversal
+        return normalised_full_path
+    if raise_exception:
+        raise ValueError("Invalid file location: directory traversal attempt detected.")
+    return None
+
 def parent_folder_create(target):
     return folder_create(parent_folder(target))
 
 def parent_folder_exists(target):
     return folder_exists(parent_folder(target))
 
+def parent_folder_name(target):
+    return folder_name(parent_folder(target))
+
 def parent_folder_not_exists(target):
     return parent_folder_exists(target) is False
 

osbot_utils/utils/Http.py

@@ -22,6 +22,13 @@ def current_host_online(url_to_use=URL_CHECK_HOST_ONLINE):
 def dns_ip_address(host):
     return socket.gethostbyname(host)
 
+def is_url_online(target):
+    try:
+        http_request(target, method='HEAD')
+        return True
+    except:
+        return False
+
 def is_port_open(host, port, timeout=0.5):
     return port_is_open(host=host, port=port, timeout=timeout)
 

osbot_utils/version

@@ -1 +1 @@
-v1.29.0
+v1.31.0

{osbot_utils-1.29.0.dist-info → osbot_utils-1.31.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: osbot_utils
-Version: 1.29.0
+Version: 1.31.0
 Summary: OWASP Security Bot - Utils
 Home-page: https://github.com/owasp-sbot/OSBot-Utils
 License: MIT
@@ -22,7 +22,7 @@ Description-Content-Type: text/markdown
 
 Powerful Python util methods and classes that simplify common apis and tasks.
 
-![Current Release](https://img.shields.io/badge/release-v1.29.0-blue)
+![Current Release](https://img.shields.io/badge/release-v1.31.0-blue)
 [![codecov](https://codecov.io/gh/owasp-sbot/OSBot-Utils/graph/badge.svg?token=GNVW0COX1N)](https://codecov.io/gh/owasp-sbot/OSBot-Utils)
 
 

{osbot_utils-1.29.0.dist-info → osbot_utils-1.31.0.dist-info}/RECORD

@@ -57,6 +57,7 @@ osbot_utils/graphs/mgraph/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 osbot_utils/helpers/CFormat.py,sha256=1_XvqGwgU6qC97MbzcKF0o7s9mCXpU5Kq9Yf-1ixUwY,6808
 osbot_utils/helpers/CPrint.py,sha256=ztKPNmT8BGxeyPXSQKRs63PqqbgxKDz_BiZmzFMup9g,1413
 osbot_utils/helpers/Dict_To_Attr.py,sha256=NdhXl5mJH7-NaBk213amzc5Nfy3tJgW-N_uYIRE4hoc,208
+osbot_utils/helpers/Hashicorp_Secrets.py,sha256=zjXa_dQvfR9L1uoulWJ8nYYaDvznV6o_QPPS4zmb6mo,4235
 osbot_utils/helpers/Local_Cache.py,sha256=0JZZX3fFImcwtbBvxAQl-EbBegSNJRhRMYF6ovTH6zY,3141
 osbot_utils/helpers/Local_Caches.py,sha256=HvuP5CURyVm_fVvJX-S4dml2bhRauzgA3be237yTaeY,1814
 osbot_utils/helpers/Print_Table.py,sha256=LEXbyqGg_6WSraI4cob4bNNSu18ddqvALp1zGK7bPhs,19126
@@ -227,7 +228,7 @@ osbot_utils/helpers/ssh/SSH__Linux__Amazon.py,sha256=ZJFb7LFTvclAuhH5OoOtJ361NoX
 osbot_utils/helpers/ssh/SSH__Python.py,sha256=O2DAwkbXzwkis8lffoqIL2NPSfYcN44Mr8i9Ey2iMKk,2066
 osbot_utils/helpers/ssh/TestCase__SSH.py,sha256=MD8sq0_kI4f6pEmEO0cLq2mQOhIqbP45ZxFJNG44Jg4,1773
 osbot_utils/helpers/ssh/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/helpers/trace/Trace_Call.py,sha256=WXw1QyHxVrkKk24NlMbrsLQdbQTgN2ocwEFqkfB6n2E,6408
+osbot_utils/helpers/trace/Trace_Call.py,sha256=nKds4xTyrF-6A3XMCxVOR37KDzB3nfCQLykrrEsqp2k,6424
 osbot_utils/helpers/trace/Trace_Call__Config.py,sha256=6nJplzrY1adz3WcwTIuwEhBCk1P0U0NbyWRzDyIox_Q,3250
 osbot_utils/helpers/trace/Trace_Call__Graph.py,sha256=HCrXRKQI42DIQxxyFLcaosWiOcUyoITbeV17ICdXcXM,1156
 osbot_utils/helpers/trace/Trace_Call__Handler.py,sha256=3gEX-DykEFixfBmD0jBdMhnTujxhNbXkjOhqxNTc9ac,11563
@@ -264,11 +265,11 @@ osbot_utils/utils/Assert.py,sha256=u9XLgYn91QvNWZGyPi29SjPJSXRHlm9andIn3NJEVog,1
 osbot_utils/utils/Call_Stack.py,sha256=MAq_0vMxnbeLfCe9qQz7GwJYaOuXpt3qtQwN6wiXsU0,6595
 osbot_utils/utils/Csv.py,sha256=oHLVpjRJqrLMz9lubMCNEoThXWju5rNTprcwHc1zq2c,1012
 osbot_utils/utils/Dev.py,sha256=HibpQutYy_iG8gGV8g1GztxNN4l29E4Bi7UZaVL6-L8,1203
-osbot_utils/utils/Env.py,sha256=uYLhqVXqqgfh03Zmf9Vdy9zFdFf0rasW6lteh_VM1xQ,5078
+osbot_utils/utils/Env.py,sha256=243O6ENzaRjHXp8DIHUuv4Wfk-zHTE18KZr0cU8uWyo,5474
 osbot_utils/utils/Exceptions.py,sha256=KyOUHkXQ_6jDTq04Xm261dbEZuRidtsM4dgzNwSG8-8,389
-osbot_utils/utils/Files.py,sha256=bZFvjyC4TAmFH6RSp3Xvj_xBxfybCT2cE7x2qNTQmeE,20834
+osbot_utils/utils/Files.py,sha256=RHbxq8AVdGT9S-OrxEWhNEOhbIrHDRU1UbGB1O05Ga8,21615
 osbot_utils/utils/Functions.py,sha256=0E6alPJ0fJpBiJgFOWooCOi265wSRyxxXAJ5CELBnso,3498
-osbot_utils/utils/Http.py,sha256=Z8V149M2HDrKBoXkDD5EXgqTGx6vQoUqXugXK__wcuw,4572
+osbot_utils/utils/Http.py,sha256=WlXEfgT_NaiDVD7vCDUxy_nOm5Qf8x_L0A3zd8B5tX8,4706
 osbot_utils/utils/Int.py,sha256=PmlUdU4lSwf4gJdmTVdqclulkEp7KPCVUDO6AcISMF4,116
 osbot_utils/utils/Json.py,sha256=UNaBazuH1R40fsHjpjuK8kmAANmUHoK9Q0PUeYmgPeY,6254
 osbot_utils/utils/Json_Cache.py,sha256=mLPkkDZN-3ZVJiDvV1KBJXILtKkTZ4OepzOsDoBPhWg,2006
@@ -285,8 +286,8 @@ osbot_utils/utils/Toml.py,sha256=dqiegndCJF7V1YT1Tc-b0-Bl6QWyL5q30urmQwMXfMQ,140
 osbot_utils/utils/Version.py,sha256=Ww6ChwTxqp1QAcxOnztkTicShlcx6fbNsWX5xausHrg,422
 osbot_utils/utils/Zip.py,sha256=t9txUxJzLBEHot6WJwF0iTTUQ1Gf_V2pVwsWzAqw_NU,12163
 osbot_utils/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-osbot_utils/version,sha256=Cnimb4t_Vj3piSoNKuKNxuAK7SFZPFgzcFqpUzq2s2A,8
-osbot_utils-1.29.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-osbot_utils-1.29.0.dist-info/METADATA,sha256=CBXxh-9F_qSZWcp7WC1L7HM7_DtuHivZ5rp5STqAS9U,1266
-osbot_utils-1.29.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-osbot_utils-1.29.0.dist-info/RECORD,,
+osbot_utils/version,sha256=xqw0vpyVEQS2xRHlm1kwNututCAIDLAR7pKKQAdsSZo,8
+osbot_utils-1.31.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+osbot_utils-1.31.0.dist-info/METADATA,sha256=QLHGRLf7-AaRW446YXqvjj86DdwwGuZgC-TeaEgwPTI,1266
+osbot_utils-1.31.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+osbot_utils-1.31.0.dist-info/RECORD,,