stac-fastapi.core 2.3.0__tar.gz → 2.4.0__tar.gz

{stac_fastapi_core-2.3.0 → stac_fastapi_core-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.core
-Version: 2.3.0
+Version: 2.4.0
 Summary: Core library for the Elasticsearch and Opensearch stac-fastapi backends.
 Home-page: https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
 License: MIT
@@ -18,13 +18,14 @@ Requires-Dist: fastapi
 Requires-Dist: attrs
 Requires-Dist: pydantic[dotenv]<2
 Requires-Dist: stac_pydantic==2.0.*
-Requires-Dist: stac-fastapi.types==2.5.3
-Requires-Dist: stac-fastapi.api==2.5.3
-Requires-Dist: stac-fastapi.extensions==2.5.3
+Requires-Dist: stac-fastapi.types==2.5.5.post1
+Requires-Dist: stac-fastapi.api==2.5.5.post1
+Requires-Dist: stac-fastapi.extensions==2.5.5.post1
 Requires-Dist: pystac[validation]
 Requires-Dist: orjson
 Requires-Dist: overrides
 Requires-Dist: geojson-pydantic
 Requires-Dist: pygeofilter==0.2.1
+Requires-Dist: typing_extensions==4.4.0
 
 # stac-fastapi core library for Elasticsearch and Opensearch backends

{stac_fastapi_core-2.3.0 → stac_fastapi_core-2.4.0}/setup.py

@@ -10,14 +10,15 @@ install_requires = [
     "attrs",
     "pydantic[dotenv]<2",
     "stac_pydantic==2.0.*",
-    "stac-fastapi.types==2.5.3",
-    "stac-fastapi.api==2.5.3",
-    "stac-fastapi.extensions==2.5.3",
+    "stac-fastapi.types==2.5.5.post1",
+    "stac-fastapi.api==2.5.5.post1",
+    "stac-fastapi.extensions==2.5.5.post1",
     "pystac[validation]",
     "orjson",
     "overrides",
     "geojson-pydantic",
     "pygeofilter==0.2.1",
+    "typing_extensions==4.4.0",
 ]
 
 setup(

stac_fastapi_core-2.4.0/stac_fastapi/core/basic_auth.py

@@ -0,0 +1,115 @@
+"""Basic Authentication Module."""
+
+import json
+import logging
+import os
+import secrets
+from typing import Any, Dict
+
+from fastapi import Depends, HTTPException, Request, status
+from fastapi.routing import APIRoute
+from fastapi.security import HTTPBasic, HTTPBasicCredentials
+from typing_extensions import Annotated
+
+from stac_fastapi.api.app import StacApi
+
+_LOGGER = logging.getLogger("uvicorn.default")
+_SECURITY = HTTPBasic()
+_BASIC_AUTH: Dict[str, Any] = {}
+
+
+def has_access(
+    request: Request, credentials: Annotated[HTTPBasicCredentials, Depends(_SECURITY)]
+) -> str:
+    """Check if the provided credentials match the expected \
+        username and password stored in environment variables for basic authentication.
+
+    Args:
+        request (Request): The FastAPI request object.
+        credentials (HTTPBasicCredentials): The HTTP basic authentication credentials.
+
+    Returns:
+        str: The username if authentication is successful.
+
+    Raises:
+        HTTPException: If authentication fails due to incorrect username or password.
+    """
+    global _BASIC_AUTH
+
+    users = _BASIC_AUTH.get("users")
+    user: Dict[str, Any] = next(
+        (u for u in users if u.get("username") == credentials.username), {}
+    )
+
+    if not user:
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Incorrect username or password",
+            headers={"WWW-Authenticate": "Basic"},
+        )
+
+    # Compare the provided username and password with the correct ones using compare_digest
+    if not secrets.compare_digest(
+        credentials.username.encode("utf-8"), user.get("username").encode("utf-8")
+    ) or not secrets.compare_digest(
+        credentials.password.encode("utf-8"), user.get("password").encode("utf-8")
+    ):
+        raise HTTPException(
+            status_code=status.HTTP_401_UNAUTHORIZED,
+            detail="Incorrect username or password",
+            headers={"WWW-Authenticate": "Basic"},
+        )
+
+    permissions = user.get("permissions", [])
+    path = request.url.path
+    method = request.method
+
+    if permissions == "*":
+        return credentials.username
+    for permission in permissions:
+        if permission["path"] == path and method in permission.get("method", []):
+            return credentials.username
+
+    raise HTTPException(
+        status_code=status.HTTP_403_FORBIDDEN,
+        detail=f"Insufficient permissions for [{method} {path}]",
+    )
+
+
+def apply_basic_auth(api: StacApi) -> None:
+    """Apply basic authentication to the provided FastAPI application \
+        based on environment variables for username, password, and endpoints.
+
+    Args:
+        api (StacApi): The FastAPI application.
+
+    Raises:
+        HTTPException: If there are issues with the configuration or format
+                       of the environment variables.
+    """
+    global _BASIC_AUTH
+
+    basic_auth_json_str = os.environ.get("BASIC_AUTH")
+    if not basic_auth_json_str:
+        _LOGGER.info("Basic authentication disabled.")
+        return
+
+    try:
+        _BASIC_AUTH = json.loads(basic_auth_json_str)
+    except json.JSONDecodeError as exception:
+        _LOGGER.error(f"Invalid JSON format for BASIC_AUTH. {exception=}")
+        raise
+    public_endpoints = _BASIC_AUTH.get("public_endpoints", [])
+    users = _BASIC_AUTH.get("users")
+    if not users:
+        raise Exception("Invalid JSON format for BASIC_AUTH. Key 'users' undefined.")
+
+    app = api.app
+    for route in app.routes:
+        if isinstance(route, APIRoute):
+            for method in route.methods:
+                endpoint = {"path": route.path, "method": method}
+                if endpoint not in public_endpoints:
+                    api.add_route_dependencies([endpoint], [Depends(has_access)])
+
+    _LOGGER.info("Basic authentication enabled.")

{stac_fastapi_core-2.3.0 → stac_fastapi_core-2.4.0}/stac_fastapi/core/core.py

@@ -677,7 +677,7 @@ class TransactionsClient(AsyncBaseTransactionsClient):
         else:
             item = await self.database.prep_create_item(item=item, base_url=base_url)
             await self.database.create_item(item, refresh=kwargs.get("refresh", False))
-            return item
+            return ItemSerializer.db_to_stac(item, base_url)
 
     @overrides
     async def update_item(

{stac_fastapi_core-2.3.0 → stac_fastapi_core-2.4.0}/stac_fastapi/core/version.py

@@ -1,2 +1,2 @@
 """library version."""
-__version__ = "2.3.0"
+__version__ = "2.4.0"

{stac_fastapi_core-2.3.0 → stac_fastapi_core-2.4.0}/stac_fastapi.core.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.core
-Version: 2.3.0
+Version: 2.4.0
 Summary: Core library for the Elasticsearch and Opensearch stac-fastapi backends.
 Home-page: https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
 License: MIT
@@ -18,13 +18,14 @@ Requires-Dist: fastapi
 Requires-Dist: attrs
 Requires-Dist: pydantic[dotenv]<2
 Requires-Dist: stac_pydantic==2.0.*
-Requires-Dist: stac-fastapi.types==2.5.3
-Requires-Dist: stac-fastapi.api==2.5.3
-Requires-Dist: stac-fastapi.extensions==2.5.3
+Requires-Dist: stac-fastapi.types==2.5.5.post1
+Requires-Dist: stac-fastapi.api==2.5.5.post1
+Requires-Dist: stac-fastapi.extensions==2.5.5.post1
 Requires-Dist: pystac[validation]
 Requires-Dist: orjson
 Requires-Dist: overrides
 Requires-Dist: geojson-pydantic
 Requires-Dist: pygeofilter==0.2.1
+Requires-Dist: typing_extensions==4.4.0
 
 # stac-fastapi core library for Elasticsearch and Opensearch backends

{stac_fastapi_core-2.3.0 → stac_fastapi_core-2.4.0}/stac_fastapi.core.egg-info/SOURCES.txt

@@ -10,6 +10,7 @@ stac_fastapi.core.egg-info/top_level.txt
 stac_fastapi/core/__init__.py
 stac_fastapi/core/base_database_logic.py
 stac_fastapi/core/base_settings.py
+stac_fastapi/core/basic_auth.py
 stac_fastapi/core/core.py
 stac_fastapi/core/datetime_utils.py
 stac_fastapi/core/serializers.py

{stac_fastapi_core-2.3.0 → stac_fastapi_core-2.4.0}/stac_fastapi.core.egg-info/requires.txt

@@ -2,11 +2,12 @@ fastapi
 attrs
 pydantic[dotenv]<2
 stac_pydantic==2.0.*
-stac-fastapi.types==2.5.3
-stac-fastapi.api==2.5.3
-stac-fastapi.extensions==2.5.3
+stac-fastapi.types==2.5.5.post1
+stac-fastapi.api==2.5.5.post1
+stac-fastapi.extensions==2.5.5.post1
 pystac[validation]
 orjson
 overrides
 geojson-pydantic
 pygeofilter==0.2.1
+typing_extensions==4.4.0