maleo-foundation 0.1.74__tar.gz → 0.1.76__tar.gz

{maleo_foundation-0.1.74 → maleo_foundation-0.1.76}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.1.74
+Version: 0.1.76
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT
@@ -8,6 +8,7 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Requires-Dist: annotated-types>=0.7.0
 Requires-Dist: anyio>=4.9.0
+Requires-Dist: bcrypt>=4.3.0
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: cachetools>=5.5.2
 Requires-Dist: certifi>=2025.1.31

{maleo_foundation-0.1.74 → maleo_foundation-0.1.76}/maleo_foundation/client/manager.py

@@ -2,12 +2,17 @@ from __future__ import annotations
 from maleo_foundation.managers.client.base import ClientManager
 from maleo_foundation.types import BaseTypes
 from maleo_foundation.utils.logging import SimpleConfig
+from maleo_foundation.client.services.encryption import (
+    MaleoFoundationAESEncryptionClientService,
+    MaleoFoundationRSAEncryptionClientService
+)
 from maleo_foundation.client.services.hash import (
     MaleoFoundationSHA256HashClientService,
     MaleoFoundationHMACHashClientService,
     MaleoFoundationBcryptHashClientService
 )
 from maleo_foundation.client.services import (
+    MaleoFoundationEncryptionServices,
     MaleoFoundationHashServices,
     MaleoFoundationSignatureClientService,
     MaleoFoundationTokenClientService,
@@ -24,6 +29,12 @@ class MaleoFoundationClientManager(ClientManager):
 
     def _initialize_services(self):
         super()._initialize_services()
+        aes_encryption_service = MaleoFoundationAESEncryptionClientService(logger=self._logger)
+        rsa_encryption_service = MaleoFoundationRSAEncryptionClientService(logger=self._logger)
+        encryption_services = MaleoFoundationEncryptionServices(
+            aes=aes_encryption_service,
+            rsa=rsa_encryption_service
+        )
         bcrypt_hash_service = MaleoFoundationBcryptHashClientService(logger=self._logger)
         hmac_hash_service = MaleoFoundationHMACHashClientService(logger=self._logger)
         sha256_hash_service = MaleoFoundationSHA256HashClientService(logger=self._logger)
@@ -35,9 +46,10 @@ class MaleoFoundationClientManager(ClientManager):
         signature_service = MaleoFoundationSignatureClientService(logger=self._logger)
         token_service = MaleoFoundationTokenClientService(logger=self._logger)
         self._services = MaleoFoundationServices(
+            encryption=encryption_services,
+            hash=hash_services,
             signature=signature_service,
-            token=token_service,
-            hash=hash_services
+            token=token_service
         )
 
     @property

{maleo_foundation-0.1.74 → maleo_foundation-0.1.76}/maleo_foundation/client/services/__init__.py

@@ -1,11 +1,13 @@
 from __future__ import annotations
 from pydantic import Field
 from maleo_foundation.managers.client.base import ClientServices
+from maleo_foundation.client.services.encryption import MaleoFoundationEncryptionServices
 from maleo_foundation.client.services.hash import MaleoFoundationHashServices
 from maleo_foundation.client.services.signature import MaleoFoundationSignatureClientService
 from maleo_foundation.client.services.token import MaleoFoundationTokenClientService
 
 class MaleoFoundationServices(ClientServices):
+    encryption:MaleoFoundationEncryptionServices = Field(..., description="Encryption's services")
     hash:MaleoFoundationHashServices = Field(..., description="Hash's services")
     signature:MaleoFoundationSignatureClientService = Field(..., description="Signature's service")
     token:MaleoFoundationTokenClientService = Field(..., description="Token's service")

maleo_foundation-0.1.76/maleo_foundation/client/services/encryption/__init__.py

@@ -0,0 +1,9 @@
+from __future__ import annotations
+from pydantic import Field
+from maleo_foundation.managers.client.base import ClientServices
+from maleo_foundation.client.services.encryption.aes import MaleoFoundationAESEncryptionClientService
+from maleo_foundation.client.services.encryption.rsa import MaleoFoundationRSAEncryptionClientService
+
+class MaleoFoundationEncryptionServices(ClientServices):
+    aes:MaleoFoundationAESEncryptionClientService = Field(..., description="AES encryption's service")
+    rsa:MaleoFoundationRSAEncryptionClientService = Field(..., description="RSA encryption's service")

maleo_foundation-0.1.76/maleo_foundation/client/services/encryption/aes.py

@@ -0,0 +1,54 @@
+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.expanded_types.encryption.aes import BaseAESEncryptionResultsTypes
+from maleo_foundation.managers.client.base import ClientService
+from maleo_foundation.models.schemas.encryption import BaseEncryptionSchemas
+from maleo_foundation.models.transfers.parameters.encryption.aes import BaseAESEncryptionParametersTransfers
+from maleo_foundation.models.transfers.results.encryption.aes import EncryptData, BaseAESEncryptionResultsTransfers
+from maleo_foundation.utils.exceptions import BaseExceptions
+
+class MaleoFoundationAESEncryptionClientService(ClientService):
+    def encrypt(self, parameters:BaseAESEncryptionParametersTransfers.Encrypt) -> BaseAESEncryptionResultsTypes.Hash:
+        """Encrypt a plaintext using AES algorithm."""
+        @BaseExceptions.service_exception_handler(
+            operation="encrypting plaintext",
+            logger=self._logger,
+            fail_result_class=BaseAESEncryptionResultsTransfers.Fail
+        )
+        def _impl():
+            #* Define random key and initialization vector bytes
+            key_bytes = os.urandom(32)
+            initialization_vector_bytes = os.urandom(16)
+            #* Encrypt message with encryptor instance
+            cipher = Cipher(algorithms.AES(key_bytes), modes.CFB(initialization_vector_bytes), backend=default_backend())
+            encryptor = cipher.encryptor()
+            ciphertext = b64encode(encryptor.update(parameters.plaintext.encode()) + encryptor.finalize()).decode('utf-8')
+            #* Encode the results to base64 strings
+            key = b64encode(key_bytes).decode('utf-8')
+            initialization_vector = b64encode(initialization_vector_bytes).decode('utf-8')
+            data = EncryptData(key=key, initialization_vector=initialization_vector, ciphertext=ciphertext)
+            self._logger.info("Plaintext successfully encrypted")
+            return BaseAESEncryptionResultsTransfers.Encrypt(data=data)
+        return _impl()
+
+    def decrypt(self, parameters:BaseAESEncryptionParametersTransfers.Decrypt) -> BaseAESEncryptionResultsTypes.Decrypt:
+        """Decrypt a ciphertext using AES algorithm."""
+        @BaseExceptions.service_exception_handler(
+            operation="verify single encryption",
+            logger=self._logger,
+            fail_result_class=BaseAESEncryptionResultsTransfers.Fail
+        )
+        def _impl():
+            #* Decode base64-encoded AES key, IV, and encrypted message
+            key_bytes = b64decode(parameters.key)
+            initialization_vector_bytes = b64decode(parameters.initialization_vector)
+            #* Decrypt message with decryptor instance
+            cipher = Cipher(algorithms.AES(key_bytes), modes.CFB(initialization_vector_bytes), backend=default_backend())
+            decryptor = cipher.decryptor()
+            plaintext = decryptor.update(b64decode(parameters.ciphertext)) + decryptor.finalize()
+            data = BaseEncryptionSchemas.Plaintext(plaintext=plaintext)
+            self._logger.info("Ciphertext successfully decrypted")
+            return BaseAESEncryptionResultsTransfers.Decrypt(data=data)
+        return _impl()

maleo_foundation-0.1.76/maleo_foundation/client/services/encryption/rsa.py

@@ -0,0 +1,68 @@
+from base64 import b64decode, b64encode
+from Crypto.Cipher import PKCS1_OAEP
+from Crypto.Hash import SHA256
+from maleo_foundation.enums import BaseEnums
+from maleo_foundation.expanded_types.encryption.rsa import BaseRSAEncryptionResultsTypes
+from maleo_foundation.managers.client.base import ClientService
+from maleo_foundation.models.schemas.encryption import BaseEncryptionSchemas
+from maleo_foundation.models.transfers.parameters.encryption.rsa import BaseRSAEncryptionParametersTransfers
+from maleo_foundation.models.transfers.results.encryption.rsa import BaseRSAEncryptionResultsTransfers
+from maleo_foundation.utils.exceptions import BaseExceptions
+from maleo_foundation.utils.loaders.key.rsa import RSAKeyLoader
+
+class MaleoFoundationRSAEncryptionClientService(ClientService):
+    def encrypt(self, parameters:BaseRSAEncryptionParametersTransfers.Encrypt) -> BaseRSAEncryptionResultsTypes.Hash:
+        """Encrypt a plaintext using RSA algorithm."""
+        @BaseExceptions.service_exception_handler(
+            operation="encrypting plaintext",
+            logger=self._logger,
+            fail_result_class=BaseRSAEncryptionResultsTransfers.Fail
+        )
+        def _impl():
+            try:
+                public_key = RSAKeyLoader.load_with_pycryptodome(type=BaseEnums.KeyType.PUBLIC, extern_key=parameters.key)
+            except TypeError:
+                message = "Invalid key type"
+                description = "A public key must be used for encrypting a plaintext"
+                other = "Ensure the given key is of type public key"
+                return BaseRSAEncryptionResultsTransfers.Fail(message=message, description=description, other=other)
+            except Exception as e:
+                self._logger.error("Unexpected error occured while trying to import key:\n'%s'", str(e), exc_info=True)
+                message = "Invalid key"
+                description = "Unexpected error occured while trying to import key"
+                other = "Ensure given key is valid"
+                return BaseRSAEncryptionResultsTransfers.Fail(message=message, description=description, other=other)
+            cipher = PKCS1_OAEP.new(public_key, hashAlgo=SHA256) #* Initialize cipher with OAEP padding and SHA-256
+            ciphertext = b64encode(cipher.encrypt(parameters.plaintext.encode('utf-8'))).decode('utf-8') #* Encrypt the plaintext and return as base64-encoded string
+            data = BaseEncryptionSchemas.Ciphertext(ciphertext=ciphertext)
+            self._logger.info("Plaintext successfully encrypted")
+            return BaseRSAEncryptionResultsTransfers.Encrypt(data=data)
+        return _impl()
+
+    def decrypt(self, parameters:BaseRSAEncryptionParametersTransfers.Decrypt) -> BaseRSAEncryptionResultsTypes.Decrypt:
+        """Decrypt a ciphertext using RSA algorithm."""
+        @BaseExceptions.service_exception_handler(
+            operation="verify single encryption",
+            logger=self._logger,
+            fail_result_class=BaseRSAEncryptionResultsTransfers.Fail
+        )
+        def _impl():
+            try:
+                private_key = RSAKeyLoader.load_with_pycryptodome(type=BaseEnums.KeyType.PRIVATE, extern_key=parameters.key, passphrase=parameters.password)
+            except TypeError:
+                message = "Invalid key type"
+                description = "A private key must be used for decrypting a ciphertext"
+                other = "Ensure the given key is of type private key"
+                return BaseRSAEncryptionResultsTransfers.Fail(message=message, description=description, other=other)
+            except Exception as e:
+                self._logger.error("Unexpected error occured while trying to import key:\n'%s'", str(e), exc_info=True)
+                message = "Invalid key"
+                description = "Unexpected error occured while trying to import key"
+                other = "Ensure given key is valid"
+                return BaseRSAEncryptionResultsTransfers.Fail(message=message, description=description, other=other)
+            cipher = PKCS1_OAEP.new(private_key, hashAlgo=SHA256) #* Initialize cipher with OAEP padding and SHA-256
+            plaintext = cipher.decrypt(b64decode(parameters.ciphertext)) #* Decode the base64-encoded ciphertext and then decrypt
+            data = BaseEncryptionSchemas.Plaintext(plaintext=plaintext)
+            self._logger.info("Ciphertext successfully decrypted")
+            return BaseRSAEncryptionResultsTransfers.Decrypt(data=data)
+        return _impl()

maleo_foundation-0.1.76/maleo_foundation/expanded_types/encryption/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+from .aes import BaseAESEncryptionResultsTransfers
+from .rsa import BaseRSAEncryptionResultsTransfers
+
+class BaseEncryptionResultsTypes:
+    AES = BaseAESEncryptionResultsTransfers
+    RSA = BaseRSAEncryptionResultsTransfers

maleo_foundation-0.1.76/maleo_foundation/expanded_types/encryption/aes.py

@@ -0,0 +1,13 @@
+from typing import Union
+from maleo_foundation.models.transfers.results.encryption.aes import BaseAESEncryptionResultsTransfers
+
+class BaseAESEncryptionResultsTypes:
+    Encrypt = Union[
+        BaseAESEncryptionResultsTransfers.Fail,
+        BaseAESEncryptionResultsTransfers.Encrypt
+    ]
+
+    Decrypt = Union[
+        BaseAESEncryptionResultsTransfers.Fail,
+        BaseAESEncryptionResultsTransfers.Decrypt
+    ]

maleo_foundation-0.1.76/maleo_foundation/expanded_types/encryption/rsa.py

@@ -0,0 +1,13 @@
+from typing import Union
+from maleo_foundation.models.transfers.results.encryption.rsa import BaseRSAEncryptionResultsTransfers
+
+class BaseRSAEncryptionResultsTypes:
+    Encrypt = Union[
+        BaseRSAEncryptionResultsTransfers.Fail,
+        BaseRSAEncryptionResultsTransfers.Encrypt
+    ]
+
+    Decrypt = Union[
+        BaseRSAEncryptionResultsTransfers.Fail,
+        BaseRSAEncryptionResultsTransfers.Decrypt
+    ]

maleo_foundation-0.1.76/maleo_foundation/models/schemas/encryption.py

@@ -0,0 +1,18 @@
+from pydantic import BaseModel, Field
+from maleo_foundation.types import BaseTypes
+
+class BaseEncryptionSchemas:
+    class Key(BaseModel):
+        key:str = Field(..., description="Key")
+
+    class Password(BaseModel):
+        password:BaseTypes.OptionalString = Field(None, min_length=32, max_length=1024, description="password")
+
+    class InitializationVector(BaseModel):
+        initialization_vector:str = Field(..., description="Initialization vector")
+
+    class Plaintext(BaseModel):
+        plaintext:str = Field(..., description="Plaintext")
+
+    class Ciphertext(BaseModel):
+        ciphertext:str = Field(..., description="Ciphertext")

maleo_foundation-0.1.76/maleo_foundation/models/transfers/parameters/encryption/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+from .aes import BaseAESEncryptionParametersTransfers
+from .rsa import BaseRSAEncryptionParametersTransfers
+
+class BaseEncryptionParametersTransfers:
+    AES = BaseAESEncryptionParametersTransfers
+    RSA = BaseRSAEncryptionParametersTransfers

maleo_foundation-0.1.76/maleo_foundation/models/transfers/parameters/encryption/aes.py

@@ -0,0 +1,13 @@
+from maleo_foundation.models.schemas.encryption import BaseEncryptionSchemas
+
+class BaseAESEncryptionParametersTransfers:
+    class Encrypt(
+        BaseEncryptionSchemas.Plaintext,
+        BaseEncryptionSchemas.Key
+    ): pass
+
+    class Decrypt(
+        BaseEncryptionSchemas.Ciphertext,
+        BaseEncryptionSchemas.InitializationVector,
+        BaseEncryptionSchemas.Key
+    ): pass

maleo_foundation-0.1.76/maleo_foundation/models/transfers/parameters/encryption/rsa.py

@@ -0,0 +1,12 @@
+from maleo_foundation.models.schemas.encryption import BaseEncryptionSchemas
+
+class BaseRSAEncryptionParametersTransfers:
+    class Encrypt(
+        BaseEncryptionSchemas.Plaintext,
+        BaseEncryptionSchemas.Key
+    ): pass
+
+    class Decrypt(
+        BaseEncryptionSchemas.Ciphertext,
+        BaseEncryptionSchemas.Key
+    ): pass

maleo_foundation-0.1.76/maleo_foundation/models/transfers/results/encryption/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+from .aes import BaseAESEncryptionResultsTransfers
+from .rsa import BaseRSAEncryptionResultsTransfers
+
+class BaseEncryptionResultsTransfers:
+    AES = BaseAESEncryptionResultsTransfers
+    RSA = BaseRSAEncryptionResultsTransfers

maleo_foundation-0.1.76/maleo_foundation/models/transfers/results/encryption/aes.py

@@ -0,0 +1,18 @@
+from pydantic import Field
+from maleo_foundation.models.transfers.results.service.general import BaseServiceGeneralResultsTransfers
+from maleo_foundation.models.schemas.encryption import BaseEncryptionSchemas
+
+class EncryptData(
+    BaseEncryptionSchemas.Ciphertext,
+    BaseEncryptionSchemas.InitializationVector,
+    BaseEncryptionSchemas.Key
+): pass
+
+class BaseAESEncryptionResultsTransfers:
+    class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
+
+    class Encrypt(BaseServiceGeneralResultsTransfers.SingleData):
+        data:EncryptData = Field(..., description="Single encryption data")
+
+    class Decrypt(BaseServiceGeneralResultsTransfers.SingleData):
+        data:BaseEncryptionSchemas.Plaintext = Field(..., description="Single decryption data")

maleo_foundation-0.1.76/maleo_foundation/models/transfers/results/encryption/rsa.py

@@ -0,0 +1,12 @@
+from pydantic import Field
+from maleo_foundation.models.transfers.results.service.general import BaseServiceGeneralResultsTransfers
+from maleo_foundation.models.schemas.encryption import BaseEncryptionSchemas
+
+class BaseRSAEncryptionResultsTransfers:
+    class Fail(BaseServiceGeneralResultsTransfers.Fail): pass
+
+    class Encrypt(BaseServiceGeneralResultsTransfers.SingleData):
+        data:BaseEncryptionSchemas.Ciphertext = Field(..., description="Single encryption data")
+
+    class Decrypt(BaseServiceGeneralResultsTransfers.SingleData):
+        data:BaseEncryptionSchemas.Plaintext = Field(..., description="Single decryption data")

{maleo_foundation-0.1.74 → maleo_foundation-0.1.76}/maleo_foundation.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: maleo_foundation
-Version: 0.1.74
+Version: 0.1.76
 Summary: Foundation package for Maleo
 Author-email: Agra Bima Yuda <agra@nexmedis.com>
 License: MIT
@@ -8,6 +8,7 @@ Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Requires-Dist: annotated-types>=0.7.0
 Requires-Dist: anyio>=4.9.0
+Requires-Dist: bcrypt>=4.3.0
 Requires-Dist: build>=1.2.2.post1
 Requires-Dist: cachetools>=5.5.2
 Requires-Dist: certifi>=2025.1.31

{maleo_foundation-0.1.74 → maleo_foundation-0.1.76}/maleo_foundation.egg-info/SOURCES.txt

@@ -16,6 +16,9 @@ maleo_foundation/client/manager.py
 maleo_foundation/client/services/__init__.py
 maleo_foundation/client/services/signature.py
 maleo_foundation/client/services/token.py
+maleo_foundation/client/services/encryption/__init__.py
+maleo_foundation/client/services/encryption/aes.py
+maleo_foundation/client/services/encryption/rsa.py
 maleo_foundation/client/services/hash/__init__.py
 maleo_foundation/client/services/hash/bcrypt.py
 maleo_foundation/client/services/hash/hmac.py
@@ -28,6 +31,9 @@ maleo_foundation/expanded_types/query.py
 maleo_foundation/expanded_types/service.py
 maleo_foundation/expanded_types/signature.py
 maleo_foundation/expanded_types/token.py
+maleo_foundation/expanded_types/encryption/__init__.py
+maleo_foundation/expanded_types/encryption/aes.py
+maleo_foundation/expanded_types/encryption/rsa.py
 maleo_foundation/managers/__init__.py
 maleo_foundation/managers/db.py
 maleo_foundation/managers/middleware.py
@@ -46,6 +52,7 @@ maleo_foundation/models/__init__.py
 maleo_foundation/models/responses.py
 maleo_foundation/models/table.py
 maleo_foundation/models/schemas/__init__.py
+maleo_foundation/models/schemas/encryption.py
 maleo_foundation/models/schemas/general.py
 maleo_foundation/models/schemas/hash.py
 maleo_foundation/models/schemas/parameter.py
@@ -62,6 +69,9 @@ maleo_foundation/models/transfers/parameters/general.py
 maleo_foundation/models/transfers/parameters/service.py
 maleo_foundation/models/transfers/parameters/signature.py
 maleo_foundation/models/transfers/parameters/token.py
+maleo_foundation/models/transfers/parameters/encryption/__init__.py
+maleo_foundation/models/transfers/parameters/encryption/aes.py
+maleo_foundation/models/transfers/parameters/encryption/rsa.py
 maleo_foundation/models/transfers/parameters/hash/__init__.py
 maleo_foundation/models/transfers/parameters/hash/bcrypt.py
 maleo_foundation/models/transfers/parameters/hash/hmac.py
@@ -74,6 +84,9 @@ maleo_foundation/models/transfers/results/client/__init__.py
 maleo_foundation/models/transfers/results/client/service.py
 maleo_foundation/models/transfers/results/client/controllers/__init__.py
 maleo_foundation/models/transfers/results/client/controllers/http.py
+maleo_foundation/models/transfers/results/encryption/__init__.py
+maleo_foundation/models/transfers/results/encryption/aes.py
+maleo_foundation/models/transfers/results/encryption/rsa.py
 maleo_foundation/models/transfers/results/service/__init__.py
 maleo_foundation/models/transfers/results/service/general.py
 maleo_foundation/models/transfers/results/service/query.py

{maleo_foundation-0.1.74 → maleo_foundation-0.1.76}/maleo_foundation.egg-info/requires.txt

@@ -1,5 +1,6 @@
 annotated-types>=0.7.0
 anyio>=4.9.0
+bcrypt>=4.3.0
 build>=1.2.2.post1
 cachetools>=5.5.2
 certifi>=2025.1.31

{maleo_foundation-0.1.74 → maleo_foundation-0.1.76}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "maleo_foundation"
-version = "0.1.74"
+version = "0.1.76"
 description = "Foundation package for Maleo"
 authors = [
     { name = "Agra Bima Yuda", email = "agra@nexmedis.com" }
@@ -15,6 +15,7 @@ requires-python = ">=3.7"
 dependencies = [
     "annotated-types>=0.7.0",
     "anyio>=4.9.0",
+    "bcrypt>=4.3.0",
     "build>=1.2.2.post1",
     "cachetools>=5.5.2",
     "certifi>=2025.1.31",