fastapi-factory-utilities 0.3.10__tar.gz → 0.4.0__tar.gz

{fastapi_factory_utilities-0.3.10 → fastapi_factory_utilities-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi_factory_utilities
-Version: 0.3.10
+Version: 0.4.0
 Summary: Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry.
 License: MIT
 Keywords: python,fastapi,beanie,httpx,opentelemetry,microservices

{fastapi_factory_utilities-0.3.10 → fastapi_factory_utilities-0.4.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "fastapi_factory_utilities"
 homepage = "https://github.com/miragecentury/fastapi_factory_utilities"
 repository = "https://github.com/miragecentury/fastapi_factory_utilities"
 keywords = ["python", "fastapi", "beanie", "httpx", "opentelemetry", "microservices"]
-version = "0.3.10"
+version = "0.4.0"
 description = "Consolidate libraries and utilities to create microservices in Python with FastAPI, Beanie, Httpx, AioPika and OpenTelemetry."
 authors = ["miragecentury <victorien.vanroye@gmail.com>"]
 maintainers = ["miragecentury <victorien.vanroye@gmail.com>"]

{fastapi_factory_utilities-0.3.10 → fastapi_factory_utilities-0.4.0}/src/fastapi_factory_utilities/core/app/config.py

@@ -82,6 +82,8 @@ class DependencyConfig(BaseModel):
     """Dependency config."""
 
     kratos: HttpServiceDependencyConfig | None = Field(default=None, description="Kratos dependency config")
+    hydra_admin: HttpServiceDependencyConfig | None = Field(default=None, description="Hydra admin dependency config")
+    hydra_public: HttpServiceDependencyConfig | None = Field(default=None, description="Hydra public dependency config")
 
 
 class RootConfig(BaseModel):

fastapi_factory_utilities-0.4.0/src/fastapi_factory_utilities/core/services/hydra/__init__.py

@@ -0,0 +1,13 @@
+"""Hydra service module."""
+
+from .exceptions import HydraOperationError, HydraTokenInvalidError
+from .objects import HydraTokenIntrospectObject
+from .services import HydraService, depends_hydra_service
+
+__all__: list[str] = [
+    "HydraOperationError",
+    "HydraService",
+    "HydraTokenIntrospectObject",
+    "HydraTokenInvalidError",
+    "depends_hydra_service",
+]

fastapi_factory_utilities-0.4.0/src/fastapi_factory_utilities/core/services/hydra/exceptions.py

@@ -0,0 +1,15 @@
+"""Python exceptions for the Hydra service."""
+
+from fastapi_factory_utilities.core.exceptions import FastAPIFactoryUtilitiesError
+
+
+class HydraError(FastAPIFactoryUtilitiesError):
+    """Base class for all exceptions raised by the Hydra service."""
+
+
+class HydraOperationError(HydraError):
+    """Exception raised when a Hydra operation fails."""
+
+
+class HydraTokenInvalidError(HydraError):
+    """Exception raised when a Hydra token is invalid."""

fastapi_factory_utilities-0.4.0/src/fastapi_factory_utilities/core/services/hydra/objects.py

@@ -0,0 +1,26 @@
+"""Provides the objects for the Hydra service."""
+
+from typing import ClassVar
+
+from pydantic import BaseModel, ConfigDict
+
+
+class HydraTokenIntrospectObject(BaseModel):
+    """Represents the object returned by the Hydra token introspection."""
+
+    model_config: ClassVar[ConfigDict] = ConfigDict(extra="ignore")
+
+    active: bool
+    aud: list[str]
+    client_id: str
+    exp: int
+    ext: dict[str, str] | None = None
+    iat: int
+    iss: str
+    nbf: int
+    obfuscated_subject: str | None = None
+    scope: str
+    sub: str
+    token_type: str
+    token_use: str
+    username: str | None = None

fastapi_factory_utilities-0.4.0/src/fastapi_factory_utilities/core/services/hydra/services.py

@@ -0,0 +1,122 @@
+"""Provides a service to interact with the Hydra service."""
+
+from base64 import b64encode
+from http import HTTPStatus
+from typing import Annotated
+
+import aiohttp
+from fastapi import Depends
+from pydantic import ValidationError
+
+from fastapi_factory_utilities.core.app import (
+    DependencyConfig,
+    HttpServiceDependencyConfig,
+    depends_dependency_config,
+)
+
+from .exceptions import HydraOperationError, HydraTokenInvalidError
+from .objects import HydraTokenIntrospectObject
+
+
+class HydraService:
+    """Service to interact with the Hydra service."""
+
+    INTROSPECT_ENDPOINT: str = "/admin/oauth2/introspect"
+    CLIENT_CREDENTIALS_ENDPOINT: str = "/oauth2/token"
+
+    def __init__(
+        self,
+        hydra_admin_http_config: HttpServiceDependencyConfig,
+        hydra_public_http_config: HttpServiceDependencyConfig,
+    ) -> None:
+        """Instanciate the Hydra service.
+
+        Args:
+            hydra_admin_http_config (HttpServiceDependencyConfig): The Hydra admin HTTP configuration.
+            hydra_public_http_config (HttpServiceDependencyConfig): The Hydra public HTTP configuration.
+        """
+        self._hydra_admin_http_config: HttpServiceDependencyConfig = hydra_admin_http_config
+        self._hydra_public_http_config: HttpServiceDependencyConfig = hydra_public_http_config
+
+    async def introspect(self, token: str) -> HydraTokenIntrospectObject:
+        """Introspects a token using the Hydra service.
+
+        Args:
+            token (str): The token to introspect.
+
+        Raises:
+            HydraOperationError: If the introspection fails.
+            HydraTokenInvalidError: If the token is invalid.
+        """
+        async with aiohttp.ClientSession(
+            base_url=str(self._hydra_admin_http_config.url),
+        ) as session:
+            async with session.post(
+                url=self.INTROSPECT_ENDPOINT,
+                data={"token": token},
+            ) as response:
+                if response.status != HTTPStatus.OK:
+                    raise HydraTokenInvalidError()
+
+                try:
+                    instrospect: HydraTokenIntrospectObject = HydraTokenIntrospectObject(**await response.json())
+                except ValidationError as error:
+                    raise HydraOperationError() from error
+
+                return instrospect
+
+    async def oauth2_client_credentials(self, client_id: str, client_secret: str, scope: str) -> str:
+        """Get the OAuth2 client credentials.
+
+        Args:
+            client_id (str): The client ID.
+            client_secret (str): The client secret.
+            scope (str): The scope.
+
+        Returns:
+            str: The access token.
+
+        Raises:
+            HydraOperationError: If the client credentials request fails.
+        """
+        # Create base64 encoded Basic Auth header
+        auth_string = f"{client_id}:{client_secret}"
+        auth_bytes = auth_string.encode("utf-8")
+        auth_b64 = b64encode(auth_bytes).decode("utf-8")
+
+        async with aiohttp.ClientSession(
+            base_url=str(self._hydra_public_http_config.url),
+        ) as session:
+            async with session.post(
+                url=self.CLIENT_CREDENTIALS_ENDPOINT,
+                headers={"Authorization": f"Basic {auth_b64}"},
+                data={"grant_type": "client_credentials", "scope": scope},
+            ) as response:
+                response_data = await response.json()
+                if response.status != HTTPStatus.OK:
+                    raise HydraOperationError(f"Failed to get client credentials: {response_data}")
+
+                return response_data["access_token"]
+
+
+def depends_hydra_service(
+    dependency_config: Annotated[DependencyConfig, Depends(depends_dependency_config)],
+) -> HydraService:
+    """Dependency injection for the Hydra service.
+
+    Args:
+        dependency_config (DependencyConfig): The dependency configuration.
+
+    Returns:
+        HydraService: The Hydra service instance.
+
+    Raises:
+        HydraOperationError: If the Hydra admin or public dependency is not configured.
+    """
+    if dependency_config.hydra_admin is None or dependency_config.hydra_public is None:
+        raise HydraOperationError(message="Hydra admin or public dependency not configured")
+
+    return HydraService(
+        hydra_admin_http_config=dependency_config.hydra_admin,
+        hydra_public_http_config=dependency_config.hydra_public,
+    )