Test case: incorrect key ID in Get Key with Key IDs

Author: brunorijsman

TODO

@@ -1,5 +1,3 @@
-TODO: Tests get wrong key-id over ETSI QKD API
-
 TODO: Put .out files in a sub-directory
 
 TODO: Add pool thresholds to configuration (and document this)

client/client.py

@@ -3,7 +3,9 @@
 """
 
 import asyncio
+from typing import Any, List, Tuple
 from uuid import UUID
+from fastapi import status
 from common import exceptions
 from common import shamir
 from common import utils
@@ -170,11 +172,13 @@ async def scatter_key_amongst_peer_hubs(
             f"for key ID {key.key_id}"
         )
         if nr_shares_successfully_scattered < _MIN_NR_SHARES:
-            causes = [
-                str(result) for result in results if isinstance(result, Exception)
-            ]
+            causes, status_code = self.summarize_failure(results)
             raise exceptions.CouldNotScatterEnoughSharesError(
-                key.key_id, nr_shares_successfully_scattered, _MIN_NR_SHARES, causes
+                key.key_id,
+                nr_shares_successfully_scattered,
+                _MIN_NR_SHARES,
+                status_code,
+                causes,
             )
 
     async def gather_key_from_peer_hubs(
@@ -201,11 +205,13 @@ async def gather_key_from_peer_hubs(
             f"for key ID {key_id}"
         )
         if nr_shares_successfully_gathered < _MIN_NR_SHARES:
-            causes = [
-                str(result) for result in results if isinstance(result, Exception)
-            ]
+            causes, status_code = self.summarize_failure(results)
             raise exceptions.CouldNotGatherEnoughSharesError(
-                key_id, nr_shares_successfully_gathered, _MIN_NR_SHARES, causes
+                key_id,
+                nr_shares_successfully_gathered,
+                _MIN_NR_SHARES,
+                status_code,
+                causes,
             )
         shamir_input = [(share.share_index, share.value) for share in shares]
         try:
@@ -216,3 +222,22 @@ async def gather_key_from_peer_hubs(
             raise exceptions.ShamirReconstructError(key_id, str(exc)) from exc
         key = UserKey(key_id, key_value)
         return key
+
+    @staticmethod
+    def summarize_failure(hub_results: List[Any]) -> Tuple[List[str], int]:
+        """
+        Map multiple peer hub failures to a single summary ETSI failure.
+        - A list of cause strings (included in the details of the ETSI exception)
+        - The status code to be used in the ETSI exception, the worst of the peer status codes.
+        """
+        status_code = None
+        causes = []
+        for hub_result in hub_results:
+            if isinstance(hub_result, Exception):
+                causes.append(str(hub_result))
+            if isinstance(hub_result, exceptions.DSKEException):
+                if status_code is None or hub_result.status_code > status_code:
+                    status_code = hub_result.status_code
+        if status_code is None:
+            status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
+        return (causes, status_code)

common/exceptions.py

@@ -2,6 +2,7 @@
 Exceptions.
 """
 
+import json
 from typing import List
 from uuid import UUID
 from fastapi import status
@@ -61,7 +62,6 @@ def __init__(
         response: str | None = None,
         exception: str | None = None,
     ):
-        message = "HTTP request failed."
         details = {}
         details["method"] = method
         details["url"] = url
@@ -77,8 +77,17 @@ def __init__(
             details["response"] = response
         if exception is not None:
             details["exception"] = exception
+        explain = ""
+        if response is not None:
+            try:
+                response_json = json.loads(response)  # type: ignore
+                if "message" in response_json:
+                    explain = f" - {response_json['message']}"
+            except Exception:  # pylint: disable=broad-except
+                pass
+        message = f"HTTP request failed ({method} {url}: {status_code}{explain})."
         super().__init__(
-            status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            status_code=status_code or status.HTTP_500_INTERNAL_SERVER_ERROR,
             message=message,
             details=details,
         )
@@ -129,11 +138,11 @@ class UnknownKeyIDError(DSKEException):
     Exception raised when an unknown key ID is provided.
     """
 
-    def __init__(self, key_id: str):
+    def __init__(self, key_id: UUID):
         super().__init__(
             status_code=status.HTTP_400_BAD_REQUEST,
             message="Unknown key ID",
-            details={"key_ID": key_id},
+            details={"key_ID": str(key_id)},
         )
 
 
@@ -147,6 +156,7 @@ def __init__(
         key_id: UUID,
         nr_successful_shares: int,
         nr_required_shares: int,
+        status_code: int,
         causes=List[str],
     ):
         details = {
@@ -157,7 +167,7 @@ def __init__(
         if causes:
             details["causes"] = causes
         super().__init__(
-            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
+            status_code=status_code,
             message="Could not scatter enough shares for key.",
             details=details,
         )
@@ -173,6 +183,7 @@ def __init__(
         key_id: UUID,
         nr_successful_shares: int,
         nr_required_shares: int,
+        status_code: int,
         causes=List[str],
     ):
         details = {
@@ -183,7 +194,7 @@ def __init__(
         if causes:
             details["causes"] = causes
         super().__init__(
-            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
+            status_code=status_code,
             message="Could not gather enough shares for key.",
             details=details,
         )

hub/__main__.py

@@ -94,10 +94,11 @@ async def dske_exception_handler(_request: fastapi.Request, exc: DSKEException):
     Handle DSKE exceptions.
     """
     # Error responses are not signed.
-    return fastapi.responses.JSONResponse(
+    response = fastapi.responses.JSONResponse(
         status_code=exc.status_code,
         content={"message": exc.message, "details": exc.details},
     )
+    return response
 
 
 @_APP.put(f"/hub/{_HUB.name}/dske/oob/v1/registration")

system_tests/system_test_common.py

@@ -214,11 +214,10 @@ def extract_key_id(output) -> None | str:
     Extract the key ID from the output of a Get Key request.
     """
     for line in output:
-        print(f"Searching for key ID in line: <{line}>", file=sys.stderr)  ### DEBUG
         match = re.search(r'"key_ID": "(\S+)"', line)
-        print(f"{match=}", file=sys.stderr)  ### DEBUG
         if match:
-            return match.group(1)
+            key_id = match.group(1)
+            return key_id
     return None
 
 

system_tests/test_etsi_qkd.py

@@ -2,6 +2,7 @@
 System test for the ETSI QKD API.
 """
 
+import uuid
 import pytest
 from . import system_test_common
 
@@ -44,3 +45,15 @@ def test_key_id_not_uuid():
     system_test_common.get_key_with_key_ids(
         "sam", "sofia", "not-a-uuid", expected_status_code=400
     )
+
+
+def test_wrong_key_id():
+    """
+    ETSI QKD Get key with key IDs, using a key ID that was not returned by Get Key (expect error).
+    """
+    key_id = system_test_common.get_key("sam", "sofia")
+    assert key_id is not None
+    wrong_uuid = str(uuid.uuid4())
+    system_test_common.get_key_with_key_ids(
+        "sam", "sofia", wrong_uuid, expected_status_code=400
+    )