jamlib 3.2.0b3__tar.gz → 3.2.0rc0__tar.gz

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jamlib
-Version: 3.2.0b3
+Version: 3.2.0rc0
 Summary: Simple and universal library for authorization.
 Author-email: Makridenko Adrian <adrianmakridenko@duck.com>, Ksenia Travnikova <kseniatravnikova@duck.com>
 License: Apache-2.0
@@ -30,7 +30,7 @@ Classifier: Framework :: FastAPI
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE.md
-Requires-Dist: cryptography>=46.0.5
+Requires-Dist: cryptography>=48.0.0
 Provides-Extra: cli
 Requires-Dist: click>=8.3.1; extra == "cli"
 Provides-Extra: redis
@@ -85,7 +85,7 @@ otp_code = jam.otp_code(secret="3DB7FOAOFBCI3WFDRE7EPF43CA")
 ## Why Jam?
 Jam is a library that provides the most popular AUTH* mechanisms right out of the box.
 
-* [JWT](https://jam.makridenko.ru/usage/jwt/)
+* [JOSE](https://jam.makridenko.ru/usage/jose/index/)
 * [PASETO](https://jam.makridenko.ru/usage/paseto/)
 * [Server side sessions](https://jam.makridenko.ru/usage/sessions/)
 * [OTP](https://jam.makridenko.ru/usage/otp/)
@@ -109,7 +109,7 @@ Here is a comparison with other libraries:
 
 | Features / Library    | **Jam** | [Authx](https://authx.yezz.me/) | [PyJWT](https://pyjwt.readthedocs.io) | [AuthLib](https://docs.authlib.org) | [OTP Auth](https://otp.authlib.org/) |
 |-----------------------|--------|----------------------------------|---------------------------------------|-------------------------------------|--------------------------------------|
-| JWT                   | ✅     | ✅                               | ✅                                    | ✅                                  | ❌                                   |
+| JOSE                  | ✅     | ❌ only JWT                      | ❌ only JWT                           | ✅                                  | ❌                                   |
 | JWT black/white lists | ✅     | ❌                               | ❌                                    | ❌                                  | ❌                                   |
 | PASETO                | ✅     | ❌                               | ❌                                    | ❌                                  | ❌                                   |
 | Server side sessions  | ✅     | ✅                               | ❌                                    | ❌                                  | ❌                                   |

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/README.md

@@ -32,7 +32,7 @@ otp_code = jam.otp_code(secret="3DB7FOAOFBCI3WFDRE7EPF43CA")
 ## Why Jam?
 Jam is a library that provides the most popular AUTH* mechanisms right out of the box.
 
-* [JWT](https://jam.makridenko.ru/usage/jwt/)
+* [JOSE](https://jam.makridenko.ru/usage/jose/index/)
 * [PASETO](https://jam.makridenko.ru/usage/paseto/)
 * [Server side sessions](https://jam.makridenko.ru/usage/sessions/)
 * [OTP](https://jam.makridenko.ru/usage/otp/)
@@ -56,7 +56,7 @@ Here is a comparison with other libraries:
 
 | Features / Library    | **Jam** | [Authx](https://authx.yezz.me/) | [PyJWT](https://pyjwt.readthedocs.io) | [AuthLib](https://docs.authlib.org) | [OTP Auth](https://otp.authlib.org/) |
 |-----------------------|--------|----------------------------------|---------------------------------------|-------------------------------------|--------------------------------------|
-| JWT                   | ✅     | ✅                               | ✅                                    | ✅                                  | ❌                                   |
+| JOSE                  | ✅     | ❌ only JWT                      | ❌ only JWT                           | ✅                                  | ❌                                   |
 | JWT black/white lists | ✅     | ❌                               | ❌                                    | ❌                                  | ❌                                   |
 | PASETO                | ✅     | ❌                               | ❌                                    | ❌                                  | ❌                                   |
 | Server side sessions  | ✅     | ✅                               | ❌                                    | ❌                                  | ❌                                   |

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "jamlib"
-version = "3.2.0b3"
+version = "3.2.0rc0"
 description = "Simple and universal library for authorization."
 authors = [
     {name = "Makridenko Adrian",email = "adrianmakridenko@duck.com"},
@@ -23,7 +23,7 @@ keywords = [
 ]
 requires-python = ">=3.10"
 dependencies = [
-    "cryptography>=46.0.5",
+    "cryptography>=48.0.0",
 ]
 
 classifiers = [

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/src/jam/__base__.py

@@ -1,16 +1,21 @@
 # -*- coding: utf-8 -*-
 
+from __future__ import annotations
+
 from abc import ABC, abstractmethod
 import gc
+import os
 from typing import Any, Literal
 
-from jam.encoders import BaseEncoder, JsonEncoder
+from jam.__base_encoder__ import BaseEncoder
+from jam.encoders import JsonEncoder
 from jam.exceptions import JamConfigurationError
 from jam.jose.__base__ import BaseJWE, BaseJWS, BaseJWT
 from jam.logger import BaseLogger, JamLogger
 from jam.oauth2.__base__ import BaseOAuth2Client
 from jam.otp.__base__ import BaseOTP, OTPConfig
 from jam.paseto.__base__ import BasePASETO
+from jam.plugins.__base__ import BasePlugin
 from jam.sessions.__base__ import BaseSessionModule
 from jam.utils.config_maker import __config_maker__, __module_loader__
 
@@ -30,15 +35,17 @@ class BaseJam(ABC):
             "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
         ] = "INFO",
         serializer: BaseEncoder | type[BaseEncoder] = JsonEncoder,
+        plugins: list[type[BasePlugin]] = [],
     ) -> None:
         """Initialize instance.
 
         Args:
-                config (Union[str, dict[str, Any]]): Configuration
-                pointer (str): Pointer
-                logger (BaseLogger): Logger
-                log_level (Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]): Log level
-                serializer (Union[BaseEncoder, type[BaseBrowser]]): Serializer
+            config (Union[str, dict[str, Any]]): Configuration
+            pointer (str): Pointer
+            logger (BaseLogger): Logger
+            log_level (Literal["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]): Log level
+            serializer (Union[BaseEncoder, type[BaseBrowser]]): Serializer
+            plugins (list[type[BasePlugin]]): List of plugins
 
         Returns:
                 None
@@ -54,6 +61,8 @@ class BaseJam(ABC):
 
         self._logger = logger(log_level)
         self._serializer = serializer
+        self._plugins = []
+
         self.jwt: BaseJWT | None = None
         self.jws: BaseJWS | None = None
         self.jwe: BaseJWE | None = None
@@ -74,6 +83,9 @@ class BaseJam(ABC):
             "BaseJam initialization complete. Modules loaded:\n"
             f" jwt={self.jwt is not None}, jose={self.jose is not None}, session={self.session is not None}, oauth2={self.oauth2 is not None}"
         )
+        if os.getenv("JAM_ENABLE_PLUGINS", "0") == "1":
+            self._logger.warning("Experimental plugins are enabled!")
+            self.__setup_plugins(plugins)
         gc.collect()
 
     def __build_main_config(
@@ -236,6 +248,40 @@ class BaseJam(ABC):
             case _:
                 raise JamConfigurationError(message="Unknown OTP type.")
 
+    def __setup_plugins(self, plugins: list[type[BasePlugin]]) -> None:
+        """Setup plugins."""
+        for plugin in plugins:
+            self._logger.debug(f"Setup plugin: {plugin.name}")
+            from jam.utils.version_check import __is_compatible__
+
+            if not __is_compatible__(None, plugin.jam_requires):
+                continue
+
+            _plugin = plugin(self)
+            _plugin.setup()
+            self._plugins.append(_plugin)
+
+    def emit(self, event: str, **kwargs) -> Any:
+        """Emit event.
+
+        Args:
+            event (str): Event name,
+            **kwargs: Event data
+        """
+        for plugin in self._plugins:
+            handler = getattr(plugin, f"on_{event}", None)
+
+            if handler:
+                try:
+                    result = handler(**kwargs)
+                    if isinstance(result, dict):
+                        kwargs.update(result)
+
+                except Exception as e:
+                    self._logger.error(f"Plugin:{plugin.name} | error: {e}")
+
+        return kwargs
+
     @abstractmethod
     def jwt_encode(
         self,
@@ -244,6 +290,7 @@ class BaseJam(ABC):
         aud: str | None = None,
         exp: int | None = None,
         nbf: int | None = None,
+        jti: str | None = None,
         *,
         payload: dict[str, Any] | None = None,
         header: dict[str, Any] | None = None,
@@ -256,6 +303,7 @@ class BaseJam(ABC):
             iss (str | None): The issuer.
             sub (str | None): The subject.
             aud (str | None): The audience.
+            jti (str | None): The JWT ID. If none use the JTI fabric function.
             header (dict[str, Any] | None): The header to include in the JWT.
             payload (dict[str, Any] | None): The payload to include in the JWT.
 

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/src/jam/__init__.py

@@ -7,10 +7,8 @@ Documentation: https://jam.makridenko.ru
 """
 
 from jam.__base__ import BaseJam
-from jam.__base_encoder__ import BaseEncoder
-from jam.encoders import JsonEncoder
 from jam.instance import Jam
 
 
-__version__ = "3.2.0b3"
-__all__ = ["Jam", "JsonEncoder", "BaseJam", "BaseEncoder"]
+__version__ = "3.2.0rc0"
+__all__ = ["Jam", "BaseJam"]

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/src/jam/aio/__base__.py

@@ -50,13 +50,14 @@ class BaseAsyncJam(BaseJam):
         raise NotImplementedError
 
     @abstractmethod
-    async def jwt_encode(
+    async def jwt_encode(  # type: ignore[override]
         self,
         iss: str | None = None,
         sub: str | None = None,
         aud: str | None = None,
         exp: int | None = None,
         nbf: int | None = None,
+        jti: str | None = None,
         *,
         payload: dict[str, Any] | None = None,
         header: dict[str, Any] | None = None,
@@ -69,6 +70,7 @@ class BaseAsyncJam(BaseJam):
             iss (str | None): The issuer.
             sub (str | None): The subject.
             aud (str | None): The audience.
+            jti (str | None): The JWT ID. If none use the JTI fabric function.
             header (dict[str, Any] | None): The header to include in the JWT.
             payload (dict[str, Any] | None): The payload to include in the JWT.
 
@@ -345,7 +347,7 @@ class BaseAsyncJam(BaseJam):
         raise NotImplementedError
 
     @abstractmethod
-    async def jws_sign(
+    async def jws_sign(  # type: ignore[override]
         self,
         data: dict[str, Any] | str,
         header: dict[str, Any] | None = None,
@@ -362,7 +364,9 @@ class BaseAsyncJam(BaseJam):
         raise NotImplementedError
 
     @abstractmethod
-    async def jws_verify(self, token: str) -> dict[str, Any]:
+    async def jws_verify(  # type: ignore[override]
+        self, token: str
+    ) -> dict[str, Any]:
         """Verify JWS token.
 
         Args:
@@ -377,7 +381,7 @@ class BaseAsyncJam(BaseJam):
         raise NotImplementedError
 
     @abstractmethod
-    async def jwe_encrypt(
+    async def jwe_encrypt(  # type: ignore[override]
         self,
         data: dict[str, Any] | str,
         header: dict[str, Any] | None = None,
@@ -394,7 +398,9 @@ class BaseAsyncJam(BaseJam):
         raise NotImplementedError
 
     @abstractmethod
-    async def jwe_decrypt(self, token: str) -> bytes:
+    async def jwe_decrypt(  # type: ignore[override]
+        self, token: str
+    ) -> bytes:
         """Decrypt JWE token.
 
         Args:

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/src/jam/aio/instance.py

@@ -81,6 +81,7 @@ class Jam(BaseAsyncJam):
         aud: str | None = None,
         exp: int | None = None,
         nbf: int | None = None,
+        jti: str | None = None,
         *,
         payload: dict[str, Any] | None = None,
         header: dict[str, Any] | None = None,
@@ -93,6 +94,7 @@ class Jam(BaseAsyncJam):
             iss (str | None): The issuer.
             sub (str | None): The subject.
             aud (str | None): The audience.
+            jti (str | None): The JWT ID. If none use the JTI fabric function.
             header (dict[str, Any] | None): The header to include in the JWT.
             payload (dict[str, Any] | None): The payload to include in the JWT.
 
@@ -100,12 +102,15 @@ class Jam(BaseAsyncJam):
             str: The encoded JWT.
         """
         assert self.jwt is not None
+        if not jti:
+            jti = self.jwt.jti
         token = self.jwt.encode(
             iss=iss,
             sub=sub,
             aud=aud,
             exp=exp,
             nbf=nbf,
+            jti=jti,
             payload=payload,
             header=header,
         )

jamlib-3.2.0rc0/src/jam/exceptions/jose.py

@@ -0,0 +1,73 @@
+# -*- coding: utf-8 -*-
+
+from .base import JamConfigurationError, JamValidationError
+
+
+class JamJWSVerificationError(JamValidationError):
+    default_message = "JWS signature verification failed."
+    default_code = "jws.verification_error"
+
+
+class JamJWSValidationError(JamValidationError):
+    default_message = "JWS validation failed."
+    default_code = "jws.validation_error"
+
+
+class JamJWSInvalidFormatError(JamValidationError):
+    default_message = "Invalid JWS format."
+    default_code = "jws.invalid_format"
+
+
+class JamJWSSigningError(JamValidationError):
+    default_message = "JWS signing failed."
+    default_code = "jws.signing_error"
+
+
+class JamJWKValidationError(JamValidationError):
+    default_message = "JWK validation failed."
+    default_code = "jwk.validation_error"
+
+
+class JamJWKInvalidKeyTypeError(JamValidationError):
+    default_message = "Unsupported JWK key type."
+    default_code = "jwk.invalid_key_type"
+
+
+class JamJWKMissingParameterError(JamValidationError):
+    default_message = "Missing required JWK parameter."
+    default_code = "jwk.missing_parameter"
+
+
+class JamJWEEncryptionError(JamValidationError):
+    default_message = "JWE encryption failed."
+    default_code = "jwe.encryption_error"
+
+
+class JamJWEDecryptionError(JamValidationError):
+    default_message = "JWE decryption failed."
+    default_code = "jwe.decryption_error"
+
+
+class JamJWEInvalidFormatError(JamValidationError):
+    default_message = "Invalid JWE format."
+    default_code = "jwe.invalid_format"
+
+
+class JamInvalidKeyTypeError(JamConfigurationError):
+    default_message = "Invalid key type."
+    default_code = "jose.invalid_key_type"
+
+
+class JamAlgorithmError(JamConfigurationError):
+    default_message = "Algorithm error."
+    default_code = "jose.algorithm_error"
+
+
+class JamInvalidPaddingError(JamValidationError):
+    default_message = "Invalid padding."
+    default_code = "jose.invalid_padding"
+
+
+class JamRedisListConfigurationError(JamConfigurationError):
+    default_message = "Redis list configuration error."
+    default_code = "jose.redis_list_configuration_error"

{jamlib-3.2.0b3 → jamlib-3.2.0rc0}/src/jam/instance.py

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 
-import datetime
 import time
 from typing import Any
 import uuid
@@ -49,9 +48,10 @@ class Jam(BaseJam):
         Returns:
             dict[str, Any]: Payload
         """
+        now = time.time()
         payload = {
-            "iat": datetime.datetime.now().timestamp(),
-            "exp": (datetime.datetime.now().timestamp() + exp) if exp else None,
+            "iat": now,
+            "exp": (now + exp) if exp else None,
             "jti": str(uuid.uuid4()),
         }
         payload = payload | data
@@ -92,6 +92,7 @@ class Jam(BaseJam):
         aud: str | None = None,
         exp: int | None = None,
         nbf: int | None = None,
+        jti: str | None = None,
         *,
         payload: dict[str, Any] | None = None,
         header: dict[str, Any] | None = None,
@@ -104,6 +105,7 @@ class Jam(BaseJam):
             iss (str | None): The issuer.
             sub (str | None): The subject.
             aud (str | None): The audience.
+            jti (str | None): The JWT ID. If none use the JTI fabric function.
             header (dict[str, Any] | None): The header to include in the JWT.
             payload (dict[str, Any] | None): The payload to include in the JWT.
 
@@ -111,12 +113,15 @@ class Jam(BaseJam):
             str: The encoded JWT.
         """
         assert self.jwt is not None
+        if not jti:
+            jti = self.jwt.jti
         token = self.jwt.encode(
             iss=iss,
             sub=sub,
             aud=aud,
             exp=exp,
             nbf=nbf,
+            jti=jti,
             payload=payload,
             header=header,
         )