dtPyAppFramework 1.3.2__tar.gz → 1.4__tar.gz

{dtpyappframework-1.3.2/src/dtPyAppFramework.egg-info → dtpyappframework-1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dtPyAppFramework
-Version: 1.3.2
+Version: 1.4
 Summary: A Python library for common features in application development.
 Author-email: Digital-Thought <dev@digital-thought.org>
 Maintainer-email: Digital-Thought <dev@digital-thought.org>

dtpyappframework-1.4/src/dtPyAppFramework/cloud/__init__.py

@@ -0,0 +1,40 @@
+from ..decorators import singleton
+from ..settings import Settings
+
+from .aws import AWSCloudSession
+from .azure import AzureCloudSession
+
+import logging
+
+
+@singleton()
+class CloudSessionManager(object):
+
+    def __init__(self):
+        logging.info('Loading Cloud Session Manager')
+
+        defined_sessions = Settings().get('cloud_sessions', [])
+        self.sessions = self.__load_sessions(defined_sessions)
+
+    @staticmethod
+    def __load_sessions(defined_sessions) -> list:
+        sessions = []
+        for defined_session in defined_sessions:
+            session_type = defined_session["session_type"]
+            name = defined_session["name"]
+            logging.info(f'Loading session "{name}" or type "{session_type}".')
+            if session_type == "aws":
+                sessions.append(AWSCloudSession(**defined_session))
+            elif session_type == "azure":
+                sessions.append(AzureCloudSession(**defined_session))
+            else:
+                logging.error(f'Unrecognised session type "{session_type}" for session "{name}".')
+
+        return sessions
+
+    def get_session(self, name):
+        for session in self.sessions:
+            if session.name == name:
+                return session.get_session()
+
+        logging.error(f'No Cloud Session with the name "{name}" was found in the defined sessions.')

dtpyappframework-1.4/src/dtPyAppFramework/cloud/aws.py

@@ -0,0 +1,53 @@
+from .cloud_session import AbstractCloudSession
+from ..misc import run_cmd
+
+import boto3
+import logging
+
+
+class AWSCloudSession(AbstractCloudSession):
+
+    def __init__(self, name, session_type, settings):
+        super().__init__(name, session_type, settings)
+
+        self.aws_profile = self.get_setting('aws_profile')
+        if not self.aws_profile:
+            logging.error('Missing required aws_profile parameter.')
+            return
+
+        self.aws_region = self.get_setting('aws_region')
+        if not self.aws_region:
+            logging.error('Missing required aws_region parameter.')
+            return
+
+        self.aws_session = self.__initialise_session()
+        if self.aws_session is None:
+            logging.error(f'An AWS Session could not be established for cloud session name "{self.name}".')
+        else:
+            self.session_available = True
+            logging.error(f'Successfully established AWS Session for cloud session name "{self.name}".')
+
+    def __initialise_session(self):
+        if self.aws_profile == 'key':
+            aws_access_key_id = self.get_setting('aws_access_key_id')
+            aws_secret_access_key = self.get_setting('aws_secret_access_key')
+            if not aws_access_key_id or not aws_secret_access_key:
+                logging.error('Missing either aws_access_key_id and aws_secret_access_key parameters.')
+                return None
+            return boto3.session.Session(region_name=self.aws_region, aws_access_key_id=aws_access_key_id,
+                                         aws_secret_access_key=aws_secret_access_key)
+        elif self.aws_profile == 'ec2':
+            self.aws_session = boto3.session.Session(region_name=self.aws_region)
+        elif self.aws_profile.startswith('sso'):
+            aws_sso_profile = self.aws_profile.split(':')[1]
+            aws_sso_resp = run_cmd(f'aws sso login --profile {aws_sso_profile}')
+            if not aws_sso_resp or "Successfully logged into Start URL" not in aws_sso_resp:
+                logging.error(f"Unable to initialise SSO for the AWS profile {aws_sso_profile}.")
+                return None
+            return boto3.session.Session(region_name=self.aws_region)
+        else:
+            logging.error(f"Unrecognised AWS Profile type {self.aws_profile}.")
+            return None
+
+    def get_session(self):
+        return self.aws_session

dtpyappframework-1.4/src/dtPyAppFramework/cloud/azure.py

@@ -0,0 +1,56 @@
+from .cloud_session import AbstractCloudSession
+
+from azure.identity import CertificateCredential, ClientSecretCredential, InteractiveBrowserCredential
+import logging
+
+
+class AzureCloudSession(AbstractCloudSession):
+
+    def __init__(self, name, session_type, settings):
+        super().__init__(name, session_type, settings)
+
+        # Get Azure identity type
+        self.azure_identity_type = self.get_setting('azure_identity_type')
+        if not self.azure_identity_type:
+            logging.error('Missing required azure_identity_type parameter.')
+            return
+
+        self.azure_tenant_id = self.get_setting('azure_tenant_id')
+        if not self.azure_tenant_id:
+            logging.error('Missing required azure_tenant_id parameter.')
+            return
+
+        self.azure_session = self.__initialise_session()
+        if self.azure_session is None:
+            logging.error(f'An Azure Session could not be established for cloud session name "{self.name}".')
+        else:
+            self.session_available = True
+            logging.error(f'Successfully established Azure Session for cloud session name "{self.name}".')
+
+    def __initialise_session(self):
+        if self.azure_identity_type == 'certificate':
+            azure_client_id = self.get_setting('azure_client_id')
+            certificate_path = self.get_setting('certificate_path')
+            if not azure_client_id or not certificate_path:
+                logging.error('Requires both azure_client_id and certificate_path parameters.')
+                return None
+            certificate_password = self.get_setting('certificate_password')
+            return CertificateCredential(tenant_id=self.azure_tenant_id, client_id=azure_client_id,
+                                         certificate_path=certificate_path, password=certificate_password)
+        elif self.azure_identity_type == 'key':
+            azure_client_id = self.get_setting('azure_client_id')
+            client_secret = self.get_setting('client_secret')
+            if not azure_client_id or not client_secret:
+                logging.error(
+                    'Requires both azure_client_id and client_secret parameters.')
+                return None
+            return ClientSecretCredential(tenant_id=self.azure_tenant_id, client_id=azure_client_id,
+                                          client_secret=client_secret)
+        elif self.azure_identity_type == 'interactive_browser':
+            return InteractiveBrowserCredential(tenant_id=self.azure_tenant_id)
+        else:
+            logging.error(f"Unrecognised Azure Identity Type {self.azure_identity_type}.")
+            return None
+
+    def get_session(self):
+        return self.azure_session

dtpyappframework-1.4/src/dtPyAppFramework/cloud/cloud_session.py

@@ -0,0 +1,17 @@
+from abc import abstractmethod
+
+
+class AbstractCloudSession:
+
+    def __init__(self, name, session_type, settings):
+        self.name = name
+        self.session_type = session_type
+        self.settings = settings
+        self.session_available = False
+
+    def get_setting(self, key):
+        return self.settings.get(key, None)
+
+    @abstractmethod
+    def get_session(self):
+        raise NotImplementedError

{dtpyappframework-1.3.2 → dtpyappframework-1.4}/src/dtPyAppFramework/settings/__init__.py

@@ -34,7 +34,8 @@ class Settings(dict):
 
         self.settings_readers = []
         self.persistent_settings_stores = []
-        self.secret_manager = SecretsManager(application_paths=self.application_paths, application_settings=self)
+        self.secret_manager = None
+        self.cloud_session_manager = None
 
         super().__init__()
 
@@ -47,6 +48,11 @@ class Settings(dict):
         self.settings_readers.append(SettingsReader(self.application_paths.usr_data_root_path, 100))
         self.settings_readers.sort(key=lambda x: x.priority)
 
+        from ..cloud import CloudSessionManager
+        self.cloud_session_manager = CloudSessionManager()
+        self.secret_manager = SecretsManager(application_paths=self.application_paths, application_settings=self,
+                                             cloud_session_manager=self.cloud_session_manager)
+
     def get_requests_tor_proxy(self) -> dict:
         """
         Gets TOR Proxy configuration in a format compatible with Requests.
@@ -168,9 +174,10 @@ class Settings(dict):
         Returns:
             Value of the item.
         """
-        persistent_value = self.secret_manager.get_secret(key)
-        if persistent_value:
-            return persistent_value
+        if self.secret_manager is not None:
+            persistent_value = self.secret_manager.get_secret(key)
+            if persistent_value:
+                return persistent_value
 
         value = None
         for reader in self.settings_readers:

{dtpyappframework-1.3.2 → dtpyappframework-1.4}/src/dtPyAppFramework/settings/secrets/__init__.py

@@ -17,7 +17,7 @@ class SecretsManager(object):
         stores (list): A list to hold different secret stores.
     """
 
-    def __init__(self, application_paths=None, application_settings=None) -> None:
+    def __init__(self, application_paths=None, application_settings=None, cloud_session_manager=None) -> None:
         """
         Initialize the SecretsManager.
 
@@ -28,6 +28,7 @@ class SecretsManager(object):
         super().__init__()
         self.application_paths = application_paths
         self.application_settings = application_settings
+        self.cloud_session_manager = cloud_session_manager
         self.stores = []
         self.store_names = []
 
@@ -36,7 +37,7 @@ class SecretsManager(object):
 
         # Add local user secret store
         self.stores.append(LocalSecretStore(store_name="User_Local_Store",
-                                            store_priority=-1,
+                                            store_priority=-0,
                                             root_store_path=self.application_paths.usr_data_root_path,
                                             application_settings=self.application_settings,
                                             app_short_name=self.application_paths.app_short_name))
@@ -44,7 +45,7 @@ class SecretsManager(object):
         try:
             # Add local app secret store (if it exists)
             self.stores.append(LocalSecretStore(store_name="App_Local_Store",
-                                                store_priority=0,
+                                                store_priority=1,
                                                 root_store_path=self.application_paths.app_data_root_path,
                                                 application_settings=self.application_settings,
                                                 app_short_name=self.application_paths.app_short_name))
@@ -54,6 +55,16 @@ class SecretsManager(object):
         # Sort stores based on priority
         self._sort_stores()
 
+    def get_local_stores_index(self):
+        _index = {"User_Local_Store": {}, "App_Local_Store": {}}
+        for key in _index:
+            store: LocalSecretStore = self.get_store(key)
+            _index[key]['available'] = store.store_available
+            _index[key]['index'] = store.get_index()
+            _index[key]['read_only'] = store.store_read_only
+
+        return _index
+
     def _sort_stores(self):
         self.stores.sort(key=lambda x: x.store_priority)
         for store in self.stores:
@@ -71,13 +82,16 @@ class SecretsManager(object):
                     self.stores.append(AWSSecretsStore(store_priority=self.application_settings.get(
                         f'secrets_manager.cloud_stores.{store_name}.priority'),
                                                        store_name=store_name,
-                                                       application_settings=self.application_settings))
+                        cloud_session_manager=self.cloud_session_manager,
+                                                       application_settings=self.application_settings,
+                    ))
 
                 # Add Azure secret store
                 if self.application_settings.get(f'secrets_manager.cloud_stores.{store_name}.store_type') == 'azure':
                     self.stores.append(AzureSecretsStore(store_priority=self.application_settings.get(
                         f'secrets_manager.cloud_stores.{store_name}.priority'),
                                                          store_name=store_name,
+                        cloud_session_manager=self.cloud_session_manager,
                                                          application_settings=self.application_settings))
 
         # Sort stores based on priority
@@ -118,12 +132,16 @@ class SecretsManager(object):
 
         for store in self.stores:
             if store_name and store_name == store.store_name:
-                value = store.get_secret(key, None)
+                if store.store_available:
+                    value = store.get_secret(key, None)
+                else:
+                    logging.error(f'Store {store.store_name} is not available to retrieve secret.')
                 break
             elif not store_name:
-                value = store.get_secret(key, None)
-                if value:
-                    break
+                if store.store_available:
+                    value = store.get_secret(key, None)
+                    if value:
+                        break
 
         if not value:
             logging.debug(f'The Secret {key} was not found. Returning default value.')
@@ -144,7 +162,10 @@ class SecretsManager(object):
             store_name = 'User_Local_Store'
         for store in self.stores:
             if store_name == store.store_name:
-                store.set_secret(key, value)
+                if store.store_available and not store.store_read_only:
+                    store.set_secret(key, value)
+                else:
+                    logging.warning(f'Secrets Store {store.store_name} is either not available or is read only.')
                 break
 
     def delete_secret(self, key, store_name='User_Local_Store'):
@@ -159,6 +180,6 @@ class SecretsManager(object):
             True if the secret is deleted, else False.
         """
         for store in self.stores:
-            if store_name and store_name == store.priority():
+            if store_name and store_name == store.name():
                 value = store.delete_secret(key)
                 break

{dtpyappframework-1.3.2 → dtpyappframework-1.4}/src/dtPyAppFramework/settings/secrets/aws_secret_store.py

@@ -6,6 +6,7 @@ from ...misc import run_cmd
 import boto3
 import logging
 
+
 class AWSSecretsStore(AbstractSecretStore):
     """
     A class representing an AWS Secrets Store for managing secrets.
@@ -20,7 +21,7 @@ class AWSSecretsStore(AbstractSecretStore):
         aws_secretsmanager (boto3.client): Boto3 client for AWS Secrets Manager.
     """
 
-    def __init__(self, store_priority, store_name, application_settings) -> None:
+    def __init__(self, store_priority, store_name, application_settings, cloud_session_manager) -> None:
         """
         Initialize the AWSSecretsStore.
 
@@ -31,43 +32,23 @@ class AWSSecretsStore(AbstractSecretStore):
         """
         super().__init__(store_name, "AWS_Secrets_Store", store_priority, application_settings)
 
+        self.cloud_session_manager = cloud_session_manager
+
         # Check if AWS CLI is installed
         if not which("aws"):
             raise SecretsStoreException("AWS Secrets Store requires the AWS Command Line Utility to be installed.")
 
-        # Get AWS profile
-        self.aws_profile = self.get_store_setting('aws_profile')
-        if not self.aws_profile:
-            raise SecretsStoreException('AWS Secrets Store is missing required aws_profile parameter.')
+        self.session_name = self.get_store_setting('session_name')
+        if not self.session_name:
+            raise SecretsStoreException('AWS Secrets Store is missing required session_name parameter.')
 
-        # Get AWS region
-        self.aws_region = self.get_store_setting('aws_region')
-        if not self.aws_region:
-            raise SecretsStoreException('AWS Secrets Store is missing required aws_region parameter.')
+        self.aws_session = self.cloud_session_manager.get_session(self.session_name)
 
-        self.aws_session = None
+        if not self.aws_session:
+            raise SecretsStoreException(f'AWS Secrets Store does not have a valid session for session name "{self.session_name}".')
 
         self.secret_name = self.get_store_setting('secret_name')
 
-        # Initialize AWS session based on profile type
-        if self.aws_profile == 'key':
-            aws_access_key_id = self.get_store_setting('aws_access_key_id')
-            aws_secret_access_key = self.get_store_setting('aws_secret_access_key')
-            if not aws_access_key_id or not aws_secret_access_key:
-                raise SecretsStoreException('AWS Secrets Store of type key requires both aws_access_key_id and aws_secret_access_key parameters.')
-            self.aws_session = boto3.session.Session(region_name=self.aws_region, aws_access_key_id=aws_access_key_id,
-                                                     aws_secret_access_key=aws_secret_access_key)
-        elif self.aws_profile == 'ec2':
-            self.aws_session = boto3.session.Session(region_name=self.aws_region)
-        elif self.aws_profile.startswith('sso'):
-            aws_sso_profile = self.aws_profile.split(':')[1]
-            aws_sso_resp = run_cmd(f'aws sso login --profile {aws_sso_profile}')
-            if not aws_sso_resp or "Successfully logged into Start URL" not in aws_sso_resp:
-                raise SecretsStoreException(f"Unable to initialise SSO for the AWS profile {aws_sso_profile}.")
-            self.aws_session = boto3.session.Session(region_name=self.aws_region)
-        else:
-            raise SecretsStoreException(f"Unrecognised AWS Profile type {self.aws_profile}.")
-
         # Initialize AWS Secrets Manager client
         self.aws_secretsmanager = self.aws_session.client('secretsmanager')
         try:

{dtpyappframework-1.3.2 → dtpyappframework-1.4}/src/dtPyAppFramework/settings/secrets/azure_secret_store.py

@@ -4,6 +4,7 @@ from azure.keyvault.secrets import SecretClient
 from azure.identity import DefaultAzureCredential, CertificateCredential, ClientSecretCredential, InteractiveBrowserCredential
 import logging
 
+
 class AzureSecretsStore(AbstractSecretStore):
     """
     A class representing an Azure Secrets Store for managing secrets.
@@ -24,7 +25,7 @@ class AzureSecretsStore(AbstractSecretStore):
         delete_secret(key): Delete a secret from Azure KeyVault.
     """
 
-    def __init__(self, store_priority, store_name, application_settings) -> None:
+    def __init__(self, store_priority, store_name, application_settings, cloud_session_manager) -> None:
         """
         Initialize the AzureSecretsStore.
 
@@ -34,6 +35,7 @@ class AzureSecretsStore(AbstractSecretStore):
             application_settings (Settings): An instance of Settings providing application settings.
         """
         super().__init__(store_name, "Azure_Secrets_Store", store_priority, application_settings)
+        self.cloud_session_manager = cloud_session_manager
 
         # Get Azure KeyVault URL
         self.azure_keyvault = self.get_store_setting('azure_keyvault')
@@ -41,38 +43,14 @@ class AzureSecretsStore(AbstractSecretStore):
             raise SecretsStoreException('Azure KeyVault Store is missing required azure_keyvault parameter.')
 
         # Get Azure identity type
-        self.azure_identity_type = self.get_store_setting('azure_identity_type')
-        if not self.azure_identity_type:
-            raise SecretsStoreException('Azure KeyVault Store is missing required azure_identity_type parameter.')
-
-        # Get Azure Tenant ID
-        self.azure_tenant_id = self.get_store_setting('azure_tenant_id')
-        if not self.azure_tenant_id:
-            raise SecretsStoreException('Azure KeyVault Store is missing required azure_tenant_id parameter.')
-
-        credential = None
-
-        # Initialize Azure credential based on identity type
-        if self.azure_identity_type == 'certificate':
-            azure_client_id = self.get_store_setting('azure_client_id')
-            certificate_path = self.get_store_setting('certificate_path')
-            if not azure_client_id or not certificate_path:
-                raise SecretsStoreException('Azure KeyVault Store of type key requires both azure_client_id and certificate_path parameters.')
-            certificate_password = self.get_store_setting('certificate_password')
-            credential = CertificateCredential(tenant_id=self.azure_tenant_id, client_id=azure_client_id,
-                                               certificate_path=certificate_path, password=certificate_password)
-        elif self.azure_identity_type == 'key':
-            azure_client_id = self.get_store_setting('azure_client_id')
-            client_secret = self.get_store_setting('client_secret')
-            if not azure_client_id or not client_secret:
-                raise SecretsStoreException(
-                    'Azure KeyVault Store of type key requires both azure_client_id and client_secret parameters.')
-            credential = ClientSecretCredential(tenant_id=self.azure_tenant_id, client_id=azure_client_id,
-                                               client_secret=client_secret)
-        elif self.azure_identity_type == 'interactive_browser':
-            credential = InteractiveBrowserCredential(tenant_id=self.azure_tenant_id)
-        else:
-            raise SecretsStoreException(f"Unrecognised Azure Identity Type {self.azure_identity_type}.")
+        self.session_name = self.get_store_setting('session_name')
+        if not self.session_name:
+            raise SecretsStoreException('Azure KeyVault Store is missing required session_name parameter.')
+
+        credential = self.cloud_session_manager.get_session(self.session_name)
+
+        if not credential:
+            raise SecretsStoreException(f'Azure KeyVault Store does not have a valid session for session name "{self.session_name}".')
 
         # Azure KeyVault URI
         self.kv_uri = f"https://{self.azure_keyvault}.vault.azure.net"

{dtpyappframework-1.3.2 → dtpyappframework-1.4}/src/dtPyAppFramework/settings/secrets/local_secret_store.py

@@ -1,3 +1,4 @@
+import json
 import os
 import sys
 import logging
@@ -53,18 +54,19 @@ class LocalSecretStore(AbstractSecretStore):
         if password is None:
             password = self.__guid()
 
-        # If the store does not exist, initialize it
-        if not os.path.exists(self.store_path):
-            self.store = self.__initialise_secrets_store(password)
-
         try:
+            # If the store does not exist, initialize it
+            if not os.path.exists(self.store_path):
+                self.store = self.__initialise_secrets_store(password)
+
             # Try to load the existing store
             self.store = pykeystore.KeyStoreEx.load(self.store_path, password)
+            self.store_available = True
+            self.store_read_only = not self.__is_writeable()
+            logging.info(f'Successfully opened Secrets Store: {self.store_path}')
         except Exception as ex:
             raise SecretsStoreException(f'Failed to open Secrets Store: {self.store_path}. Error: {str(ex)}')
 
-        logging.info(f'Successfully opened Secrets Store: {self.store_path}')
-
     def __initialise_secrets_store(self, password):
         """
         Initialize the secrets store if it doesn't exist.
@@ -129,6 +131,7 @@ class LocalSecretStore(AbstractSecretStore):
         entry = self.store.getPassword(account=key)
         if not entry or entry == 'NONE':
             return default_value
+
         return entry
 
     def set_secret(self, key, value):
@@ -144,6 +147,9 @@ class LocalSecretStore(AbstractSecretStore):
 
         self.store.setPassword(account=key, password=value)
         self.__save()
+        index = self.get_index()
+        index.append(key)
+        self.__set_index(index)
 
     def delete_secret(self, key):
         """
@@ -154,7 +160,31 @@ class LocalSecretStore(AbstractSecretStore):
         """
         entry = self.store.setPassword(account=key, password='NONE')
         self.__save()
+        index = self.get_index()
+        index.remove(key)
+        self.__set_index(index)
+
+    def __set_index(self, index: list):
+        logging.info(index)
+        self.store.setPassword(account=f'{self.store_name}.INDEX', password=json.dumps(index))
+        self.__save()
+
+    def get_index(self) -> list:
+        index = self.get_secret(f'{self.store_name}.INDEX', None)
+        if index is None:
+            self.__set_index([])
+            return []
+
+        return json.loads(index)
 
     def __save(self):
         """Save the changes made to the local secret store."""
         self.store.save(self.store_path, self.__guid())
+
+    def __is_writeable(self):
+        try:
+            self.__save()
+            return True
+        except Exception as ex:
+            logging.warning(str(ex))
+            return False

{dtpyappframework-1.3.2 → dtpyappframework-1.4}/src/dtPyAppFramework/settings/secrets/secret_store.py

@@ -41,6 +41,8 @@ class AbstractSecretStore(object):
         self.store_priority = store_priority
         self.store_type = store_type
         self.application_settings = application_settings
+        self.store_available: bool = False
+        self.store_read_only: bool = True
 
     def priority(self):
         """Get the priority of the secret store."""

dtpyappframework-1.4/src/dtPyAppFramework/version.dat

@@ -0,0 +1 @@
+1.4

{dtpyappframework-1.3.2 → dtpyappframework-1.4/src/dtPyAppFramework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dtPyAppFramework
-Version: 1.3.2
+Version: 1.4
 Summary: A Python library for common features in application development.
 Author-email: Digital-Thought <dev@digital-thought.org>
 Maintainer-email: Digital-Thought <dev@digital-thought.org>

{dtpyappframework-1.3.2 → dtpyappframework-1.4}/src/dtPyAppFramework.egg-info/SOURCES.txt

@@ -12,6 +12,10 @@ src/dtPyAppFramework.egg-info/SOURCES.txt
 src/dtPyAppFramework.egg-info/dependency_links.txt
 src/dtPyAppFramework.egg-info/requires.txt
 src/dtPyAppFramework.egg-info/top_level.txt
+src/dtPyAppFramework/cloud/__init__.py
+src/dtPyAppFramework/cloud/aws.py
+src/dtPyAppFramework/cloud/azure.py
+src/dtPyAppFramework/cloud/cloud_session.py
 src/dtPyAppFramework/decorators/__init__.py
 src/dtPyAppFramework/logging/__init__.py
 src/dtPyAppFramework/logging/default_logging.py

dtpyappframework-1.3.2/src/dtPyAppFramework/version.dat

@@ -1 +0,0 @@
-1.3.2