maleo-foundation 0.3.58__py3-none-any.whl → 0.3.59__py3-none-any.whl

maleo_foundation/client/services/encryption/aes.py

@@ -2,6 +2,7 @@ import os
 from base64 import b64decode, b64encode
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives.ciphers import Cipher, algorithms, modes
+from maleo_foundation.enums import BaseEnums
 from maleo_foundation.expanded_types.encryption.aes import (
     MaleoFoundationAESEncryptionResultsTypes,
 )
@@ -14,7 +15,10 @@ from maleo_foundation.models.transfers.results.encryption.aes import (
     EncryptData,
     MaleoFoundationAESEncryptionResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
+
+
+RESOURCE = "aes_encryptions"
 
 
 class MaleoFoundationAESEncryptionClientService(ClientService):
@@ -23,8 +27,13 @@ class MaleoFoundationAESEncryptionClientService(ClientService):
     ) -> MaleoFoundationAESEncryptionResultsTypes.Encrypt:
         """Encrypt a plaintext using AES algorithm."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="encrypting plaintext",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="encrypting plaintext",
             logger=self._logger,
             fail_result_class=MaleoFoundationAESEncryptionResultsTransfers.Fail,
         )
@@ -53,7 +62,15 @@ class MaleoFoundationAESEncryptionClientService(ClientService):
                 ciphertext=ciphertext,
             )
             self._logger.info("Plaintext successfully encrypted")
-            return MaleoFoundationAESEncryptionResultsTransfers.Encrypt(data=data)  # type: ignore
+            return MaleoFoundationAESEncryptionResultsTransfers.Encrypt(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
@@ -62,8 +79,13 @@ class MaleoFoundationAESEncryptionClientService(ClientService):
     ) -> MaleoFoundationAESEncryptionResultsTypes.Decrypt:
         """Decrypt a ciphertext using AES algorithm."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="verify single encryption",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="verify single encryption",
             logger=self._logger,
             fail_result_class=MaleoFoundationAESEncryptionResultsTransfers.Fail,
         )
@@ -84,6 +106,14 @@ class MaleoFoundationAESEncryptionClientService(ClientService):
             ).decode()
             data = MaleoFoundationEncryptionSchemas.Plaintext(plaintext=plaintext)
             self._logger.info("Ciphertext successfully decrypted")
-            return MaleoFoundationAESEncryptionResultsTransfers.Decrypt(data=data)  # type: ignore
+            return MaleoFoundationAESEncryptionResultsTransfers.Decrypt(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/client/services/encryption/rsa.py

@@ -13,18 +13,26 @@ from maleo_foundation.models.transfers.parameters.encryption.rsa import (
 from maleo_foundation.models.transfers.results.encryption.rsa import (
     MaleoFoundationRSAEncryptionResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
 from maleo_foundation.utils.loaders.key.rsa import RSAKeyLoader
 
 
+RESOURCE = "rsa_encryptions"
+
+
 class MaleoFoundationRSAEncryptionClientService(ClientService):
     def encrypt(
         self, parameters: MaleoFoundationRSAEncryptionParametersTransfers.Encrypt
     ) -> MaleoFoundationRSAEncryptionResultsTypes.Encrypt:
         """Encrypt a plaintext using RSA algorithm."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="encrypting plaintext",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="encrypting plaintext",
             logger=self._logger,
             fail_result_class=MaleoFoundationRSAEncryptionResultsTransfers.Fail,
         )
@@ -60,7 +68,15 @@ class MaleoFoundationRSAEncryptionClientService(ClientService):
             ).decode("utf-8")
             data = MaleoFoundationEncryptionSchemas.Ciphertext(ciphertext=ciphertext)
             self._logger.info("Plaintext successfully encrypted")
-            return MaleoFoundationRSAEncryptionResultsTransfers.Encrypt(data=data)  # type: ignore
+            return MaleoFoundationRSAEncryptionResultsTransfers.Encrypt(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
@@ -69,8 +85,13 @@ class MaleoFoundationRSAEncryptionClientService(ClientService):
     ) -> MaleoFoundationRSAEncryptionResultsTypes.Decrypt:
         """Decrypt a ciphertext using RSA algorithm."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="verify single encryption",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="verify single encryption",
             logger=self._logger,
             fail_result_class=MaleoFoundationRSAEncryptionResultsTransfers.Fail,
         )
@@ -106,6 +127,14 @@ class MaleoFoundationRSAEncryptionClientService(ClientService):
             plaintext = cipher.decrypt(b64decode(parameters.ciphertext)).decode()
             data = MaleoFoundationEncryptionSchemas.Plaintext(plaintext=plaintext)
             self._logger.info("Ciphertext successfully decrypted")
-            return MaleoFoundationRSAEncryptionResultsTransfers.Decrypt(data=data)  # type: ignore
+            return MaleoFoundationRSAEncryptionResultsTransfers.Decrypt(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/client/services/hash/bcrypt.py

@@ -1,4 +1,5 @@
 import bcrypt
+from maleo_foundation.enums import BaseEnums
 from maleo_foundation.expanded_types.hash import MaleoFoundationHashResultsTypes
 from maleo_foundation.managers.client.base import ClientService
 from maleo_foundation.models.schemas.hash import MaleoFoundationHashSchemas
@@ -8,7 +9,10 @@ from maleo_foundation.models.transfers.parameters.hash.bcrypt import (
 from maleo_foundation.models.transfers.results.hash import (
     MaleoFoundationHashResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
+
+
+RESOURCE = "bcrypt_hashes"
 
 
 class MaleoFoundationBcryptHashClientService(ClientService):
@@ -17,8 +21,13 @@ class MaleoFoundationBcryptHashClientService(ClientService):
     ) -> MaleoFoundationHashResultsTypes.Hash:
         """Generate a bcrypt hash for the given message."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="hashing single message",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="hashing single message",
             logger=self._logger,
             fail_result_class=MaleoFoundationHashResultsTransfers.Fail,
         )
@@ -28,7 +37,15 @@ class MaleoFoundationBcryptHashClientService(ClientService):
             ).decode()
             data = MaleoFoundationHashSchemas.Hash(hash=hash)
             self._logger.info("Message successfully hashed")
-            return MaleoFoundationHashResultsTransfers.Hash(data=data)
+            return MaleoFoundationHashResultsTransfers.Hash(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
@@ -37,8 +54,13 @@ class MaleoFoundationBcryptHashClientService(ClientService):
     ) -> MaleoFoundationHashResultsTypes.Verify:
         """Verify a message against the given message hash."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="verify single hash",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="verify single hash",
             logger=self._logger,
             fail_result_class=MaleoFoundationHashResultsTransfers.Fail,
         )
@@ -49,6 +71,14 @@ class MaleoFoundationBcryptHashClientService(ClientService):
             )
             data = MaleoFoundationHashSchemas.IsValid(is_valid=is_valid)
             self._logger.info("Hash successfully verified")
-            return MaleoFoundationHashResultsTransfers.Verify(data=data)
+            return MaleoFoundationHashResultsTransfers.Verify(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/client/services/hash/hmac.py

@@ -1,4 +1,5 @@
 from Crypto.Hash import HMAC, SHA256
+from maleo_foundation.enums import BaseEnums
 from maleo_foundation.expanded_types.hash import MaleoFoundationHashResultsTypes
 from maleo_foundation.managers.client.base import ClientService
 from maleo_foundation.models.schemas.hash import MaleoFoundationHashSchemas
@@ -8,7 +9,10 @@ from maleo_foundation.models.transfers.parameters.hash.hmac import (
 from maleo_foundation.models.transfers.results.hash import (
     MaleoFoundationHashResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
+
+
+RESOURCE = "hmac_hashes"
 
 
 class MaleoFoundationHMACHashClientService(ClientService):
@@ -17,8 +21,13 @@ class MaleoFoundationHMACHashClientService(ClientService):
     ) -> MaleoFoundationHashResultsTypes.Hash:
         """Generate a hmac hash for the given message."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="hashing single message",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="hashing single message",
             logger=self._logger,
             fail_result_class=MaleoFoundationHashResultsTransfers.Fail,
         )
@@ -30,7 +39,15 @@ class MaleoFoundationHMACHashClientService(ClientService):
             ).hexdigest()
             data = MaleoFoundationHashSchemas.Hash(hash=hash)
             self._logger.info("Message successfully hashed")
-            return MaleoFoundationHashResultsTransfers.Hash(data=data)
+            return MaleoFoundationHashResultsTransfers.Hash(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
@@ -39,8 +56,13 @@ class MaleoFoundationHMACHashClientService(ClientService):
     ) -> MaleoFoundationHashResultsTypes.Verify:
         """Verify a message against the given message hash."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="verify single hash",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="verify single hash",
             logger=self._logger,
             fail_result_class=MaleoFoundationHashResultsTransfers.Fail,
         )
@@ -53,6 +75,14 @@ class MaleoFoundationHMACHashClientService(ClientService):
             is_valid = computed_hash == parameters.hash
             data = MaleoFoundationHashSchemas.IsValid(is_valid=is_valid)
             self._logger.info("Hash successfully verified")
-            return MaleoFoundationHashResultsTransfers.Verify(data=data)
+            return MaleoFoundationHashResultsTransfers.Verify(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/client/services/hash/sha256.py

@@ -1,4 +1,5 @@
 from Crypto.Hash import SHA256
+from maleo_foundation.enums import BaseEnums
 from maleo_foundation.expanded_types.hash import MaleoFoundationHashResultsTypes
 from maleo_foundation.managers.client.base import ClientService
 from maleo_foundation.models.schemas.hash import MaleoFoundationHashSchemas
@@ -8,7 +9,10 @@ from maleo_foundation.models.transfers.parameters.hash.sha256 import (
 from maleo_foundation.models.transfers.results.hash import (
     MaleoFoundationHashResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
+
+
+RESOURCE = "sha256_hashes"
 
 
 class MaleoFoundationSHA256HashClientService(ClientService):
@@ -17,8 +21,13 @@ class MaleoFoundationSHA256HashClientService(ClientService):
     ) -> MaleoFoundationHashResultsTypes.Hash:
         """Generate a sha256 hash for the given message."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="hashing single message",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="hashing single message",
             logger=self._logger,
             fail_result_class=MaleoFoundationHashResultsTransfers.Fail,
         )
@@ -26,7 +35,15 @@ class MaleoFoundationSHA256HashClientService(ClientService):
             hash = SHA256.new(parameters.message.encode()).hexdigest()
             data = MaleoFoundationHashSchemas.Hash(hash=hash)
             self._logger.info("Message successfully hashed")
-            return MaleoFoundationHashResultsTransfers.Hash(data=data)
+            return MaleoFoundationHashResultsTransfers.Hash(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
@@ -35,8 +52,13 @@ class MaleoFoundationSHA256HashClientService(ClientService):
     ) -> MaleoFoundationHashResultsTypes.Verify:
         """Verify a message against the given message hash."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="verify single hash",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="verify single hash",
             logger=self._logger,
             fail_result_class=MaleoFoundationHashResultsTransfers.Fail,
         )
@@ -45,6 +67,14 @@ class MaleoFoundationSHA256HashClientService(ClientService):
             is_valid = computed_hash == parameters.hash
             data = MaleoFoundationHashSchemas.IsValid(is_valid=is_valid)
             self._logger.info("Hash successfully verified")
-            return MaleoFoundationHashResultsTransfers.Verify(data=data)
+            return MaleoFoundationHashResultsTransfers.Verify(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/client/services/key.py

@@ -1,6 +1,7 @@
 from cryptography.hazmat.backends import default_backend
 from cryptography.hazmat.primitives.asymmetric import rsa
 from cryptography.hazmat.primitives import serialization
+from maleo_foundation.enums import BaseEnums
 from maleo_foundation.expanded_types.key import MaleoFoundationKeyResultsTypes
 from maleo_foundation.managers.client.base import ClientService
 from maleo_foundation.models.transfers.general.key import (
@@ -12,7 +13,10 @@ from maleo_foundation.models.transfers.parameters.key import (
 from maleo_foundation.models.transfers.results.key import (
     MaleoFoundationKeyResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
+
+
+RESOURCE = "keys"
 
 
 class MaleoFoundationKeyClientService(ClientService):
@@ -21,8 +25,13 @@ class MaleoFoundationKeyClientService(ClientService):
     ) -> MaleoFoundationKeyResultsTypes.CreatePrivate:
         """Create an RSA private key with X.509 encoding in .pem format."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="creating private key",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="creating private key",
             logger=self._logger,
             fail_result_class=MaleoFoundationKeyResultsTransfers.Fail,
         )
@@ -52,7 +61,15 @@ class MaleoFoundationKeyClientService(ClientService):
             data = MaleoFoundationKeyGeneralTransfers.PrivateKey(
                 value=private_key_bytes.decode()
             )  # type: ignore
-            return MaleoFoundationKeyResultsTransfers.CreatePrivate(data=data)  # type: ignore
+            return MaleoFoundationKeyResultsTransfers.CreatePrivate(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
@@ -61,8 +78,13 @@ class MaleoFoundationKeyClientService(ClientService):
     ) -> MaleoFoundationKeyResultsTypes.CreatePublic:
         """Create an RSA public key with X.509 encoding in .pem format."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="creating public key",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="creating public key",
             logger=self._logger,
             fail_result_class=MaleoFoundationKeyResultsTransfers.Fail,
         )
@@ -87,7 +109,15 @@ class MaleoFoundationKeyClientService(ClientService):
             data = MaleoFoundationKeyGeneralTransfers.PublicKey(
                 value=public_key_bytes.decode()
             )  # type: ignore
-            return MaleoFoundationKeyResultsTransfers.CreatePublic(data=data)  # type: ignore
+            return MaleoFoundationKeyResultsTransfers.CreatePublic(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
@@ -96,8 +126,13 @@ class MaleoFoundationKeyClientService(ClientService):
     ) -> MaleoFoundationKeyResultsTypes.CreatePair:
         """Create an RSA key pair with X.509 encoding in .pem format."""
 
-        @BaseExceptions.service_exception_handler(
-            operation="creating key pair",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="creating key pair",
             logger=self._logger,
             fail_result_class=MaleoFoundationKeyResultsTransfers.Fail,
         )
@@ -141,6 +176,14 @@ class MaleoFoundationKeyClientService(ClientService):
             data = MaleoFoundationKeyGeneralTransfers.KeyPair(
                 private=private, public=public
             )
-            return MaleoFoundationKeyResultsTransfers.CreatePair(data=data)  # type: ignore
+            return MaleoFoundationKeyResultsTransfers.CreatePair(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/client/services/signature.py

@@ -13,16 +13,24 @@ from maleo_foundation.models.transfers.parameters.signature import (
 from maleo_foundation.models.transfers.results.signature import (
     MaleoFoundationSignatureResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
 from maleo_foundation.utils.loaders.key.rsa import RSAKeyLoader
 
 
+RESOURCE = "signatures"
+
+
 class MaleoFoundationSignatureClientService(ClientService):
     def sign(
         self, parameters: MaleoFoundationSignatureParametersTransfers.Sign
     ) -> MaleoFoundationSignatureResultsTypes.Sign:
-        @BaseExceptions.service_exception_handler(
-            operation="signing single message",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="signing single message",
             logger=self._logger,
             fail_result_class=MaleoFoundationSignatureResultsTransfers.Fail,
         )
@@ -58,15 +66,28 @@ class MaleoFoundationSignatureClientService(ClientService):
             ).decode()  # * Sign the hashed message
             data = MaleoFoundationSignatureSchemas.Signature(signature=signature)
             self._logger.info("Message successfully signed")
-            return MaleoFoundationSignatureResultsTransfers.Sign(data=data)  # type: ignore
+            return MaleoFoundationSignatureResultsTransfers.Sign(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
     def verify(
         self, parameters: MaleoFoundationSignatureParametersTransfers.Verify
     ) -> MaleoFoundationSignatureResultsTypes.Verify:
-        @BaseExceptions.service_exception_handler(
-            operation="verify single signature",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="verify single signature",
             logger=self._logger,
             fail_result_class=MaleoFoundationSignatureResultsTransfers.Fail,
         )
@@ -103,6 +124,14 @@ class MaleoFoundationSignatureClientService(ClientService):
                 is_valid = False
             data = MaleoFoundationSignatureSchemas.IsValid(is_valid=is_valid)
             self._logger.info("Signature successfully verified")
-            return MaleoFoundationSignatureResultsTransfers.Verify(data=data)  # type: ignore
+            return MaleoFoundationSignatureResultsTransfers.Verify(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/client/services/token.py

@@ -12,16 +12,24 @@ from maleo_foundation.models.transfers.parameters.token import (
 from maleo_foundation.models.transfers.results.token import (
     MaleoFoundationTokenResultsTransfers,
 )
-from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.exceptions.service import BaseServiceExceptions
 from maleo_foundation.utils.loaders.key.rsa import RSAKeyLoader
 
 
+RESOURCE = "tokens"
+
+
 class MaleoFoundationTokenClientService(ClientService):
     def encode(
         self, parameters: MaleoFoundationTokenParametersTransfers.Encode
     ) -> MaleoFoundationTokenResultsTypes.Encode:
-        @BaseExceptions.service_exception_handler(
-            operation="encoding a payload into a token",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="encoding a payload into a token",
             logger=self._logger,
             fail_result_class=MaleoFoundationTokenResultsTransfers.Fail,
         )
@@ -58,15 +66,28 @@ class MaleoFoundationTokenClientService(ClientService):
                 payload=payload, key=private_key.export_key(), algorithm="RS256"
             )
             data = MaleoFoundationTokenSchemas.Token(token=token)
-            return MaleoFoundationTokenResultsTransfers.Encode(data=data)  # type: ignore
+            return MaleoFoundationTokenResultsTransfers.Encode(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()
 
     def decode(
         self, parameters: MaleoFoundationTokenParametersTransfers.Decode
     ) -> MaleoFoundationTokenResultsTypes.Decode:
-        @BaseExceptions.service_exception_handler(
-            operation="decoding a token into a payload",
+        @BaseServiceExceptions.sync_exception_handler(
+            layer=BaseEnums.OperationLayer.SERVICE,
+            target=BaseEnums.OperationTarget.INTERNAL,
+            resource=RESOURCE,
+            operation=BaseEnums.OperationType.CREATE,
+            create_type=BaseEnums.CreateType.CREATE,
+            summary="decoding a token into a payload",
             logger=self._logger,
             fail_result_class=MaleoFoundationTokenResultsTransfers.Fail,
         )
@@ -100,6 +121,14 @@ class MaleoFoundationTokenClientService(ClientService):
             data = MaleoFoundationTokenGeneralTransfers.DecodePayload.model_validate(
                 payload
             )
-            return MaleoFoundationTokenResultsTransfers.Decode(data=data)  # type: ignore
+            return MaleoFoundationTokenResultsTransfers.Decode(
+                origin=BaseEnums.OperationOrigin.CLIENT,
+                layer=BaseEnums.OperationLayer.SERVICE,
+                target=BaseEnums.OperationTarget.INTERNAL,
+                resource=RESOURCE,
+                operation=BaseEnums.OperationType.CREATE,
+                create_type=BaseEnums.CreateType.CREATE,
+                data=data,
+            )  # type: ignore
 
         return _impl()

maleo_foundation/enums.py

@@ -110,6 +110,7 @@ class BaseEnums:
         CACHE = "cache"
         CONTROLLER = "controller"
         DATABASE = "database"
+        INTERNAL = "internal"
         MICROSERVICE = "microservice"
         THIRD_PARTY = "third_party"
 

{maleo_foundation-0.3.58.dist-info → maleo_foundation-0.3.59.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.3.58
+Version: 0.3.59
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT

{maleo_foundation-0.3.58.dist-info → maleo_foundation-0.3.59.dist-info}/RECORD

@@ -2,23 +2,23 @@ maleo_foundation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 maleo_foundation/authentication.py,sha256=2Y2py-teDSO_YTFdZiPtuYhC8r3qIzn7CKyLNN8b2NQ,2727
 maleo_foundation/authorization.py,sha256=8P1hleBYRv8kda4uQcbHVujHVAlI92YV1Flfzf-oJEU,285
 maleo_foundation/constants.py,sha256=cgW2TjXYEdQRoYCL3fMk3r5B2Yr-Av67CaEAdY5SZ6o,1529
-maleo_foundation/enums.py,sha256=AwfCsYBa8ieqxc6N0gVwqJ7GFj7M76qI1mDw_9LrU9I,6153
+maleo_foundation/enums.py,sha256=mmyhys-vcx9CQhTx3QVf_NiQYIwWBSN8VTXmnB3w5GU,6183
 maleo_foundation/extended_types.py,sha256=oOAYc5f89WcPt5OWEaNdeceENHiPVr4KDhdttg6bA_w,305
 maleo_foundation/rest_controller_result.py,sha256=uZxBxZ5hB98q1B4hNyRigHcO0560NYfUjq8L662aOPw,2172
 maleo_foundation/types.py,sha256=Tq50KOISbnsMslVGBCqlY77lRAQZa-UUFDGqqwRglow,2466
 maleo_foundation/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 maleo_foundation/client/manager.py,sha256=5Ww2CNbKOT4nifI8roO77xlBrxIKCTCUEJHCNbRjGX4,2729
 maleo_foundation/client/services/__init__.py,sha256=srDKoa3zRt-PvfHcXlFJbwagT0O3wwicL3qbMb3Odug,1104
-maleo_foundation/client/services/key.py,sha256=YYKgVARQiznJ6Cs1xXRYBA-jSrcBP-w1lKKo0xOqrq4,5976
-maleo_foundation/client/services/signature.py,sha256=_xXtSk2y0fX4ilhGoVH8Q3nS2dxVBep2EIZXrJgBZoc,5121
-maleo_foundation/client/services/token.py,sha256=mYxaZKxei2plhkpoKm5QWNRO0instWuoXkrnnoD4lRo,4825
+maleo_foundation/client/services/key.py,sha256=2OzlBygNsAW9WkTxHkQNneAy5jvrzXuxHvN-E5mBkxY,7856
+maleo_foundation/client/services/signature.py,sha256=c9uWHDjUsONlA9vwU_EBetsmUNc97qsHf4OfBzyi0MQ,6362
+maleo_foundation/client/services/token.py,sha256=zAJ1Gg8diodt1eKfv-t9DRgp2JttU4wq65p-Zyhyfeo,6062
 maleo_foundation/client/services/encryption/__init__.py,sha256=-rnOE-p0B9vEpBHBuMG3jzfZAwH6_GYNx6_ctQOBHCQ,644
-maleo_foundation/client/services/encryption/aes.py,sha256=nIMognacAIqFStwa_HcLvmtb-8YaaXmJkeNMwB0BFIc,3898
-maleo_foundation/client/services/encryption/rsa.py,sha256=JRWh5bfQG3Ry2ViEIXdbaXa_JopWtAOJg_HpanzOZdQ,5383
+maleo_foundation/client/services/encryption/aes.py,sha256=UuM4mKFCgcNgV5bZj64DRyNx27pii21uCHTVKvQMKQY,5189
+maleo_foundation/client/services/encryption/rsa.py,sha256=sL3uxqIZuerWGkvqRWLhdBq6Zkrk0C9AMnsv6-8A6gY,6629
 maleo_foundation/client/services/hash/__init__.py,sha256=W4O-Novao01fqy_rTDOC6TQS7-l-wSQUyGCkn49JqvY,830
-maleo_foundation/client/services/hash/bcrypt.py,sha256=x5qcWhkwexOURVyepHHbHr2Ttd5Q86yHRyDyKmkZr4E,2204
-maleo_foundation/client/services/hash/hmac.py,sha256=zw0hVXLnxNLR_bAJhX8Lu6JIADw1zp3pzd_-dhHBsKU,2348
-maleo_foundation/client/services/hash/sha256.py,sha256=MhgyTX--VyQote7eLxQnn80tguCR2u4O2LGdSs3cyQ4,2130
+maleo_foundation/client/services/hash/bcrypt.py,sha256=x2tzOIjOs9WuF76P-rOT8Drtbt1ykPgHGqRuRC5VzIY,3525
+maleo_foundation/client/services/hash/hmac.py,sha256=NN8acXUMvZvxoMcYnt0OcIeq4WWW7Va5fLmswSSTRbg,3667
+maleo_foundation/client/services/hash/sha256.py,sha256=Ei9yg6ta60gTaycF33jGKHUrctGEKFeRVvzoKsD0LgY,3451
 maleo_foundation/expanded_types/__init__.py,sha256=5GYECG5mEaH7p3kTH0CH8LUDnIW5URm9do-FYe0QtnU,297
 maleo_foundation/expanded_types/client.py,sha256=mcFGAECXp4jIzG1P_831MRBa4F3RYnZ2JaIHZHXw-jU,2375
 maleo_foundation/expanded_types/general.py,sha256=Yo86OCtqzvaMcQuNL4uE3SSRlAiABXZ4Vurf85SCBi4,1476
@@ -135,7 +135,7 @@ maleo_foundation/utils/loaders/credential/__init__.py,sha256=g-cAxkTE2EtHaG8Tv52
 maleo_foundation/utils/loaders/credential/google.py,sha256=GCJl-bsKSSxoE_ERAkIzRrRNIbIEeqYOhHwzFuBr0mk,6576
 maleo_foundation/utils/loaders/key/__init__.py,sha256=RfqIbUxkdlx1xrbzJZPD_JHiRFNFLRuQs8JoUPCGCv4,108
 maleo_foundation/utils/loaders/key/rsa.py,sha256=UXcP0rr4QVacTsHLNQuU05wcow5CHWz-JW-zsVxlbPs,4121
-maleo_foundation-0.3.58.dist-info/METADATA,sha256=x1DAgEqufMl2OJFRrcaJW1yFqxVfbRQBJOPwmivEONA,4150
-maleo_foundation-0.3.58.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-maleo_foundation-0.3.58.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
-maleo_foundation-0.3.58.dist-info/RECORD,,
+maleo_foundation-0.3.59.dist-info/METADATA,sha256=p20luMK_I1f5VTK6U0i3ai5XEScDdClNyEw8MyoJTWU,4150
+maleo_foundation-0.3.59.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+maleo_foundation-0.3.59.dist-info/top_level.txt,sha256=_iBos3F_bhEOdjOnzeiEYSrCucasc810xXtLBXI8cQc,17
+maleo_foundation-0.3.59.dist-info/RECORD,,