amsdal 0.5.34__cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl

amsdal/context/manager.pyi

@@ -0,0 +1,50 @@
+from contextvars import ContextVar
+from typing import Any
+
+_CONTEXT: ContextVar[dict[str, Any] | None]
+
+class AmsdalContextManager:
+    """
+    Manages a context for storing and retrieving data.
+
+    This class provides methods to get, set, and add to a context stored in a
+    `ContextVar`. The context is a dictionary that can hold any key-value pairs.
+    """
+    @classmethod
+    def get_context(cls) -> dict[str, Any]:
+        """
+        Retrieves the current context or creates a new one if none exists.
+
+        This method gets the current context from the `_CONTEXT` variable. If no
+        context exists, it creates a new empty context and sets it.
+
+        Returns:
+            dict[str, Any]: The current context.
+        """
+    @classmethod
+    def set_context(cls, context: dict[str, Any]) -> None:
+        """
+        Sets the context to the provided dictionary.
+
+        This method sets the `_CONTEXT` variable to the provided context.
+
+        Args:
+            context (dict[str, Any]): The context to set.
+
+        Returns:
+            None
+        """
+    @classmethod
+    def add_to_context(cls, key: str, value: Any) -> None:
+        """
+        Adds a key-value pair to the current context.
+
+        This method adds the provided key-value pair to the current context.
+
+        Args:
+            key (str): The key to add to the context.
+            value (Any): The value to associate with the key.
+
+        Returns:
+            None
+        """

amsdal/contrib/app_config.py

@@ -0,0 +1,7 @@
+from abc import ABC
+from abc import abstractmethod
+
+
+class AppConfig(ABC):
+    @abstractmethod
+    def on_ready(self) -> None: ...

amsdal/contrib/app_config.pyi

@@ -0,0 +1,6 @@
+import abc
+from abc import ABC, abstractmethod
+
+class AppConfig(ABC, metaclass=abc.ABCMeta):
+    @abstractmethod
+    def on_ready(self) -> None: ...

amsdal/contrib/auth/app.py

@@ -0,0 +1,27 @@
+from amsdal_utils.lifecycle.enum import LifecycleEvent
+from amsdal_utils.lifecycle.producer import LifecycleProducer
+
+from amsdal.contrib.app_config import AppConfig
+
+
+class AuthAppConfig(AppConfig):
+    """
+    Configuration class for the authentication application.
+
+    This class sets up the necessary listeners for various lifecycle events
+    related to authentication and permission checks.
+    """
+
+    def on_ready(self) -> None:
+        """
+        Sets up listeners for various lifecycle events.
+
+        This method adds listeners for server startup, user authentication, and permission checks.
+        """
+        from amsdal.contrib.auth.lifecycle.consumer import AuthenticateUserConsumer
+        from amsdal.contrib.auth.lifecycle.consumer import CheckAndCreateSuperUserConsumer
+        from amsdal.contrib.auth.lifecycle.consumer import CheckPermissionConsumer
+
+        LifecycleProducer.add_listener(LifecycleEvent.ON_SERVER_STARTUP, CheckAndCreateSuperUserConsumer)
+        LifecycleProducer.add_listener(LifecycleEvent.ON_AUTHENTICATE, AuthenticateUserConsumer)
+        LifecycleProducer.add_listener(LifecycleEvent.ON_PERMISSION_CHECK, CheckPermissionConsumer)

amsdal/contrib/auth/app.pyi

@@ -0,0 +1,15 @@
+from amsdal.contrib.app_config import AppConfig as AppConfig
+
+class AuthAppConfig(AppConfig):
+    """
+    Configuration class for the authentication application.
+
+    This class sets up the necessary listeners for various lifecycle events
+    related to authentication and permission checks.
+    """
+    def on_ready(self) -> None:
+        """
+        Sets up listeners for various lifecycle events.
+
+        This method adds listeners for server startup, user authentication, and permission checks.
+        """

amsdal/contrib/auth/decorators/__init__.py

@@ -0,0 +1,35 @@
+import asyncio
+from collections.abc import Callable
+from functools import wraps
+from typing import Any
+
+from amsdal.context.manager import AmsdalContextManager
+from amsdal.contrib.auth.errors import AuthenticationError
+
+
+def require_auth(func: Callable[..., Any]) -> Callable[..., Any]:
+    if asyncio.iscoroutinefunction(func):
+
+        @wraps(func)
+        async def wrapper(*args: Any, **kwargs: Any) -> Callable[..., Any]:
+            request = AmsdalContextManager().get_context().get('request', None)
+
+            if not request or not request.user:
+                msg = 'Authentication required'
+                raise AuthenticationError(msg)
+
+            return await func(*args, **kwargs)
+
+    else:
+
+        @wraps(func)
+        def wrapper(*args: Any, **kwargs: Any) -> Callable[..., Any]:
+            request = AmsdalContextManager().get_context().get('request', None)
+
+            if not request or not request.user:
+                msg = 'Authentication required'
+                raise AuthenticationError(msg)
+
+            return func(*args, **kwargs)
+
+    return wrapper

amsdal/contrib/auth/decorators/__init__.pyi

@@ -0,0 +1,6 @@
+from amsdal.context.manager import AmsdalContextManager as AmsdalContextManager
+from amsdal.contrib.auth.errors import AuthenticationError as AuthenticationError
+from collections.abc import Callable as Callable
+from typing import Any
+
+def require_auth(func: Callable[..., Any]) -> Callable[..., Any]: ...

amsdal/contrib/auth/errors.py

@@ -0,0 +1,43 @@
+from amsdal_utils.errors import AmsdalError
+
+
+class UserCreationError(AmsdalError): ...
+
+
+class AuthenticationError(AmsdalError): ...
+
+
+class MFARequiredError(AuthenticationError):
+    """Raised when MFA verification is required but not provided."""
+
+    ...
+
+
+class InvalidMFACodeError(AuthenticationError):
+    """Raised when the provided MFA code is invalid."""
+
+    ...
+
+
+class MFADeviceNotFoundError(AmsdalError):
+    """Raised when no valid MFA device is found for the user."""
+
+    ...
+
+
+class MFASetupError(AmsdalError):
+    """Raised when there's an error during MFA device setup."""
+
+    ...
+
+
+class PermissionDeniedError(AmsdalError):
+    """Raised when a user lacks permission for an operation."""
+
+    ...
+
+
+class UserNotFoundError(AmsdalError):
+    """Raised when a target user cannot be found."""
+
+    ...

amsdal/contrib/auth/errors.pyi

@@ -0,0 +1,16 @@
+from amsdal_utils.errors import AmsdalError
+
+class UserCreationError(AmsdalError): ...
+class AuthenticationError(AmsdalError): ...
+class MFARequiredError(AuthenticationError):
+    """Raised when MFA verification is required but not provided."""
+class InvalidMFACodeError(AuthenticationError):
+    """Raised when the provided MFA code is invalid."""
+class MFADeviceNotFoundError(AmsdalError):
+    """Raised when no valid MFA device is found for the user."""
+class MFASetupError(AmsdalError):
+    """Raised when there's an error during MFA device setup."""
+class PermissionDeniedError(AmsdalError):
+    """Raised when a user lacks permission for an operation."""
+class UserNotFoundError(AmsdalError):
+    """Raised when a target user cannot be found."""

amsdal/contrib/auth/fixtures/basic_permissions.json

@@ -0,0 +1,64 @@
+{
+    "Permission": [
+        {
+            "_external_id": "user_delete",
+            "model": "User",
+            "action": "delete"
+        },
+        {
+            "_external_id": "user_read",
+            "model": "User",
+            "action": "read"
+        },
+        {
+            "_external_id": "user_update",
+            "model": "User",
+            "action": "update"
+        },
+        {
+            "_external_id": "user_all_actions",
+            "model": "User",
+            "action": "*"
+        },
+        {
+            "_external_id": "all_models_all_actions",
+            "model": "*",
+            "action": "*"
+        },
+        {
+            "_external_id": "login_session_delete",
+            "model": "LoginSession",
+            "action": "delete"
+        },
+        {
+            "_external_id": "login_session_read",
+            "model": "LoginSession",
+            "action": "read"
+        },
+        {
+            "_external_id": "login_session_update",
+            "model": "LoginSession",
+            "action": "update"
+        },
+        {
+            "_external_id": "permission_delete",
+            "model": "Permission",
+            "action": "delete"
+        },
+        {
+            "_external_id": "permission_read",
+            "model": "Permission",
+            "action": "read"
+        },
+        {
+            "_external_id": "permission_update",
+            "model": "Permission",
+            "action": "update"
+        },
+        {
+            "_external_id": "permission_create",
+            "model": "Permission",
+            "action": "create"
+        }
+    ]
+}