jamlib 3.0.0b11.dev0__tar.gz → 3.0.0b12.dev1__tar.gz

{jamlib-3.0.0b11.dev0/src/jamlib.egg-info → jamlib-3.0.0b12.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jamlib
-Version: 3.0.0b11.dev0
+Version: 3.0.0b12.dev1
 Summary: Simple and universal library for authorization.
 Author-email: Makridenko Adrian <adrianmakridenko@duck.com>, Ksenia Travnikova <kseniatravnikova@duck.com>
 License: Apache-2.0

{jamlib-3.0.0b11.dev0 → jamlib-3.0.0b12.dev1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "jamlib"
-version = "3.0.0b11.dev0"
+version = "3.0.0b12.dev1"
 description = "Simple and universal library for authorization."
 authors = [
     {name = "Makridenko Adrian",email = "adrianmakridenko@duck.com"},

{jamlib-3.0.0b11.dev0 → jamlib-3.0.0b12.dev1}/src/jam/__init__.py

@@ -12,5 +12,5 @@ from jam.encoders import JsonEncoder
 from jam.instance import Jam
 
 
-__version__ = "3.0.0b10.dev0"
+__version__ = "3.0.0b12.dev1"
 __all__ = ["Jam", "JsonEncoder", "BaseJam", "BaseEncoder"]

jamlib-3.0.0b12.dev1/src/jam/ext/litestar/__init__.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+Litestar integration.
+
+Litestar docs: https://docs.litestar.dev
+"""
+
+from .objects import (
+    BaseUser,
+    SimpleUser,
+    Token
+)
+
+from .plugins import BasePlugin, JamJWTPlugin
+
+__all__ = [
+    "BaseUser",
+    "SimpleUser",
+    "Token",
+    "BasePlugin",
+    "JamJWTPlugin",
+]

jamlib-3.0.0b12.dev1/src/jam/ext/litestar/middleware.py

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+
+from litestar.connection import ASGIConnection
+from litestar.middleware import (
+    AbstractAuthenticationMiddleware,
+    AuthenticationResult,
+)
+
+from jam.exceptions import JamLitestarPluginConfigError
+from jam.ext.litestar.objects import BaseUser, Token
+from jam.jwt import JWT
+
+
+class JWTMiddleware(AbstractAuthenticationMiddleware):
+    """Middleware created by jam plugin."""
+
+    HEADER_NAME: str | None
+    COOKIE_NAME: str | None
+    AUTH_MODULE: JWT
+    USER: type[BaseUser]
+
+    def __get_auth_token(self, connection: ASGIConnection) -> str | None:
+        if self.HEADER_NAME:
+            token = connection.headers.get(self.HEADER_NAME, None)
+        elif self.COOKIE_NAME:
+            token = connection.cookies.get(self.COOKIE_NAME, None)
+        else:
+            raise JamLitestarPluginConfigError(
+                message="No header or cookie name provided for JWT authentication.",
+                details={
+                    "header_name": self.HEADER_NAME,
+                    "cookie_name": self.COOKIE_NAME,
+                },
+            )
+        return token
+
+    async def authenticate_request(  # noqa
+        self, connection: ASGIConnection
+    ) -> AuthenticationResult:
+        token = self.__get_auth_token(connection)
+        token_model = Token(token=token)
+        if not token:
+            return AuthenticationResult(None, auth=token_model)
+        try:
+            data = self.AUTH_MODULE.decode(token)
+            user = self.USER.from_payload(data)
+
+            return AuthenticationResult(user, token_model)
+        except Exception:
+            raise Exception  # TODO: нормальная ошибка

jamlib-3.0.0b12.dev1/src/jam/ext/litestar/objects.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import Any, TypeVar
+
+
+User = TypeVar("User", bound="BaseUser")
+
+
+@dataclass(slots=True)
+class Token:
+    """Data for Authresult."""
+
+    token: str | None
+
+
+@dataclass
+class BaseUser(ABC):
+    """Abstract user model for AuthResult."""
+
+    @classmethod
+    @abstractmethod
+    def from_payload(cls, payload: dict[str, Any]) -> User:
+        """Build model from payload.
+
+        Args:
+            payload (dict[str, Any]): Payload for your data.
+        """
+        raise NotImplementedError
+
+
+@dataclass
+class SimpleUser(BaseUser):
+    """Simple user with payload."""
+
+    payload: dict[str, Any]
+
+    @classmethod
+    def from_payload(cls, payload: dict[str, Any]) -> SimpleUser:
+        """Set payload=payload."""
+        return cls(payload)

{jamlib-3.0.0b11.dev0 → jamlib-3.0.0b12.dev1}/src/jam/ext/litestar/plugins.py

@@ -8,6 +8,7 @@ from litestar.di import Provide
 from litestar.plugins import InitPlugin
 
 from jam.exceptions import JamLitestarPluginConfigError
+from jam.ext.litestar.objects import BaseUser
 from jam.jwt import JWT
 from jam.utils.config_maker import GENERIC_POINTER, __config_maker__
 
@@ -15,16 +16,16 @@ from jam.utils.config_maker import GENERIC_POINTER, __config_maker__
 class BasePlugin(InitPlugin):
     """Base Litestar plugin."""
 
-    _AUTH_MODULE: Callable
+    MODULE: Callable
 
     def _setup_config(self, config: dict[str, Any]) -> None:
-        self._auth = self._AUTH_MODULE(**config)
+        self._auth = self.MODULE(**config)
 
 
 class JamJWTPlugin(BasePlugin):
     """JWT plugin for litestar."""
 
-    _AUTH_MODULE = JWT
+    MODULE = JWT
 
     def __init__(  # noqa
         self,
@@ -32,9 +33,11 @@ class JamJWTPlugin(BasePlugin):
         pointer: str = GENERIC_POINTER,
         cookie_name: str | None = None,
         header_name: str | None = None,
+        middleware: bool = True,
+        middleware_user: type[BaseUser] | None = None,
         **kwargs,
     ) -> None:
-        if not cookie_name and not header_name:
+        if middleware and (not cookie_name and not header_name):
             raise JamLitestarPluginConfigError(
                 message="Cookie name and header name cannot be both None.",
                 details={
@@ -42,13 +45,36 @@ class JamJWTPlugin(BasePlugin):
                     "header_name": header_name,
                 },
             )
+        if middleware and not middleware_user:
+            raise JamLitestarPluginConfigError(
+                message="Middleware user cannot be None when middleware is True.",
+                details={
+                    "middleware_user": middleware_user,
+                },
+            )
 
         _config: dict[str, Any] | None = (
-            (__config_maker__(config, pointer)) if config else None
+            __config_maker__(config, pointer) if config else None
         )
 
-    def on_app_init(self, app_config: AppConfig) -> AppConfig:  # noqa: D102
+        self._auth = self.MODULE(**(_config if _config else kwargs))
+        self._middleware = None
+
+        if middleware:
+            from jam.ext.litestar.middleware import JWTMiddleware
+
+            _middleware = JWTMiddleware
+            _middleware.COOKIE_NAME = cookie_name
+            _middleware.HEADER_NAME = header_name
+            _middleware.AUTH_MODULE = self._auth
+            _middleware.USER = middleware_user  # type: ignore
+            self._middleware = _middleware
+
+    def on_app_init(self, app_config: AppConfig) -> AppConfig:  # noqa
         app_config.dependencies["jwt"] = Provide(
             lambda: self._auth, sync_to_thread=True
         )
+        app_config.middleware.append(
+            self._middleware
+        ) if self._middleware else None
         return app_config

{jamlib-3.0.0b11.dev0 → jamlib-3.0.0b12.dev1/src/jamlib.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: jamlib
-Version: 3.0.0b11.dev0
+Version: 3.0.0b12.dev1
 Summary: Simple and universal library for authorization.
 Author-email: Makridenko Adrian <adrianmakridenko@duck.com>, Ksenia Travnikova <kseniatravnikova@duck.com>
 License: Apache-2.0

{jamlib-3.0.0b11.dev0 → jamlib-3.0.0b12.dev1}/src/jamlib.egg-info/SOURCES.txt

@@ -37,6 +37,8 @@ src/jam/ext/fastapi/__init__.py
 src/jam/ext/flask/__init__.py
 src/jam/ext/flask/extensions.py
 src/jam/ext/litestar/__init__.py
+src/jam/ext/litestar/middleware.py
+src/jam/ext/litestar/objects.py
 src/jam/ext/litestar/plugins.py
 src/jam/ext/starlette/__init__.py
 src/jam/ext/starlette/auth_backends.py

jamlib-3.0.0b11.dev0/src/jam/ext/litestar/__init__.py

@@ -1,7 +0,0 @@
-# -*- coding: utf-8 -*-
-
-"""
-Litestar integration.
-
-Litestar docs: https://docs.litestar.dev
-"""