api: Rename the authentication function

Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>

diff --git a/src/dbl/api/__init__.py b/src/dbl/api/__init__.py
index 81596c525dca82f3f04e60edad63ee4e2f246ed5..60f294900b873a7dfa2de4cb6b277166c9846d74 100644 (file)
--- a/src/dbl/api/__init__.py
+++ b/src/dbl/api/__init__.py
@@ -49,9 +49,12 @@ backend = app.state.backend = Backend(
 
 api_key_header = fastapi.security.APIKeyHeader(name="X-API-Key")
 
-async def require_api_key(request: fastapi.Request, api_key: str = fastapi.Depends(api_key_header)):
+async def require_current_user(
+               request: fastapi.Request,
+               api_key: str = fastapi.Depends(api_key_header),
+):
        """
-               Requires that a client provides a valid API key
+               Authenticates a user
        """
        # Try to authenticate the user
        key = await backend.auth(api_key)

diff --git a/src/dbl/api/lists.py b/src/dbl/api/lists.py
index 558d5c3adcba7bf390752c5b974cedad4d1624f7..c72703fb11eedcba07e6915196c8d1d754e1b1f7 100644 (file)
--- a/src/dbl/api/lists.py
+++ b/src/dbl/api/lists.py
@@ -29,7 +29,7 @@ from .. import reports
 from .. import sources
 
 # Import the main app
-from . import require_api_key
+from . import require_current_user
 from . import app
 from . import backend
 
@@ -108,7 +108,7 @@ class CreateReport(pydantic.BaseModel):
 async def list_report(
        report: CreateReport,
        list = fastapi.Depends(get_list_from_path),
-       user = fastapi.Depends(require_api_key),
+       user = fastapi.Depends(require_current_user),
 ) -> reports.Report:
        return await list.report(
                name        = report.name,

diff --git a/src/dbl/api/reports.py b/src/dbl/api/reports.py
index 4853ddabfee92a768fd26d2cdbe383a53e7726bf..23f933869eb62098ef9397e16fb229a192ffd733 100644 (file)
--- a/src/dbl/api/reports.py
+++ b/src/dbl/api/reports.py
@@ -26,7 +26,7 @@ import uuid
 from .. import reports
 
 # Import the main app
-from . import require_api_key
+from . import require_current_user
 from . import app
 from . import backend
 
@@ -70,7 +70,7 @@ async def get_reports() -> typing.List[reports.Report]:
 @router.post("")
 async def create_report(
        report: CreateReport,
-       user = fastapi.Depends(require_api_key),
+       user = fastapi.Depends(require_current_user),
 ) -> reports.Report:
        # Fetch the list
        list = await backend.lists.get_by_slug(report.list)