initial commit

Author: giancarloromeo

packages/models-library/src/models_library/api_schemas_webserver/auth.py

@@ -2,6 +2,7 @@
 from typing import Annotated, Any
 
 from models_library.basic_types import IDStr
+from models_library.rest_base import RequestParameters
 from pydantic import AliasGenerator, ConfigDict, Field, HttpUrl, SecretStr
 from pydantic.alias_generators import to_camel
 
@@ -53,6 +54,16 @@ class UnregisterCheck(InputSchema):
 #
 
 
+class ApiKeyListQueryParams(RequestParameters):
+    include_autogenerated: Annotated[
+        bool,
+        Field(
+            description="If True, then the list includes autogenerated API keys. "
+            "Otherwise, only user-created API keys are returned.",
+        ),
+    ] = False
+
+
 class ApiKeyCreateRequest(InputSchema):
     display_name: Annotated[str, Field(..., min_length=3)]
     expiration: Annotated[

packages/models-library/src/models_library/auth.py

@@ -0,0 +1,3 @@
+from typing import Literal, TypeAlias
+
+API_KEY_AUTOGENERATED_PREFIX: TypeAlias = Literal["__auto_"]

services/director-v2/src/simcore_service_director_v2/modules/osparc_variables/_api_auth.py

@@ -4,6 +4,7 @@
 from uuid import uuid5
 
 from fastapi import FastAPI
+from models_library.auth import API_KEY_AUTOGENERATED_PREFIX
 from models_library.products import ProductName
 from models_library.projects import ProjectID
 from models_library.projects_nodes_io import NodeID
@@ -27,7 +28,7 @@ def create_unique_api_name_for(
 ) -> str:
     # NOTE: The namespace chosen doesn't significantly impact the resulting UUID
     # as long as it's consistently used across the same context
-    return f"__auto_{uuid5(uuid.NAMESPACE_DNS, f'{product_name}/{user_id}/{project_id}/{node_id}')}"
+    return f"{API_KEY_AUTOGENERATED_PREFIX}{uuid5(uuid.NAMESPACE_DNS, f'{product_name}/{user_id}/{project_id}/{node_id}')}"
 
 
 async def create_user_api_key(

services/web/server/src/simcore_service_webserver/api_keys/_controller/rest.py

@@ -7,6 +7,7 @@
     ApiKeyCreateRequest,
     ApiKeyCreateResponse,
     ApiKeyGet,
+    ApiKeyListQueryParams,
 )
 from models_library.basic_types import IDStr
 from models_library.rest_base import StrictRequestParameters
@@ -15,6 +16,7 @@
 from servicelib.aiohttp.requests_validation import (
     parse_request_body_as,
     parse_request_path_parameters_as,
+    parse_request_query_parameters_as,
 )
 
 from ..._meta import API_VTAG
@@ -68,10 +70,15 @@ async def create_api_key(request: web.Request):
 @handle_plugin_requests_exceptions
 async def list_api_keys(request: web.Request):
     req_ctx = RequestContext.model_validate(request)
+
+    query_params: ApiKeyListQueryParams = parse_request_query_parameters_as(
+        ApiKeyListQueryParams, request
+    )
     api_keys = await _service.list_api_keys(
         request.app,
         user_id=req_ctx.user_id,
         product_name=req_ctx.product_name,
+        include_autogenerated=query_params.include_autogenerated,
     )
     return envelope_json_response(
         TypeAdapter(list[ApiKeyGet]).validate_python(api_keys)

services/web/server/src/simcore_service_webserver/api_keys/_repository.py

@@ -3,6 +3,7 @@
 
 import sqlalchemy as sa
 from aiohttp import web
+from models_library.auth import API_KEY_AUTOGENERATED_PREFIX
 from models_library.products import ProductName
 from models_library.users import UserID
 from simcore_postgres_database.models.api_keys import api_keys
@@ -160,12 +161,18 @@ async def list_api_keys(
     *,
     user_id: UserID,
     product_name: ProductName,
+    include_autogenerated: bool = False,
 ) -> list[ApiKey]:
     async with pass_or_acquire_connection(get_asyncpg_engine(app), connection) as conn:
         stmt = sa.select(api_keys.c.id, api_keys.c.display_name).where(
             (api_keys.c.user_id == user_id) & (api_keys.c.product_name == product_name)
         )
 
+        if not include_autogenerated:
+            stmt = stmt.where(
+                ~api_keys.c.display_name.like(f"{API_KEY_AUTOGENERATED_PREFIX}%")
+            )
+
         result = await conn.stream(stmt)
         rows = [row async for row in result]
 

services/web/server/src/simcore_service_webserver/api_keys/_service.py

@@ -2,9 +2,7 @@
 
 from aiohttp import web
 from models_library.products import ProductName
-from models_library.rpc.webserver.auth.api_keys import (
-    generate_api_key_and_secret,
-)
+from models_library.rpc.webserver.auth.api_keys import generate_api_key_and_secret
 from models_library.users import UserID
 
 from . import _repository
@@ -87,9 +85,13 @@ async def list_api_keys(
     *,
     product_name: ProductName,
     user_id: UserID,
+    include_autogenerated: bool = False,
 ) -> list[ApiKey]:
     api_keys: list[ApiKey] = await _repository.list_api_keys(
-        app, user_id=user_id, product_name=product_name
+        app,
+        user_id=user_id,
+        product_name=product_name,
+        include_autogenerated=include_autogenerated,
     )
     return api_keys