Merge remote-tracking branch 'origin' into debt/GPCAPIM-359-sort-out-env-vars

davidhamill1-nhs · davidhamill1-nhs · commit 8c5b9d65f295 · 2026-04-27T13:51:10.000+01:00
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
diff --git a/Makefile b/Makefile
@@ -61,6 +61,18 @@ deploy: clean build # Build project artefact and deploy locally @Pipeline
 	else \
 		$(docker) run --platform linux/amd64 --name gateway-api -p 5000:8080 --env-file .env -d ${IMAGE_NAME} ; \
 	fi
+	@max_attempts=5 ; \
+	attempt=1 ; \
+	while [[ $$attempt -le $$max_attempts ]]; do \
+		if $(docker) ps --filter "name=gateway-api" --filter "status=running" --format "{{.Names}}" | grep -q "^gateway-api$$"; then \
+			exit 0 ; \
+		fi ; \
+		sleep $$((attempt * 2)) ; \
+		attempt=$$((attempt + 1)) ; \
+	done ; \
+	echo "ERROR: gateway-api container failed to start. Logs:" ; \
+	$(docker) logs gateway-api ; \
+	exit 1
 
 deploy-%: # Build project artefact and deploy locally as specified environment - mandatory: name=[name of the environment, e.g. 'dev'] @Pipeline
 	make env-$* deploy
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,23 @@
+# Security
+
+We take security and the protection of private data extremely seriously. If you believe you have found a vulnerability or other issue which has compromised or could compromise the security of any of our systems or private data managed by our systems, please do not hesitate to contact us using the method outlined below.
+
+## Table of Contents
+
+- [Security](#security)
+  - [Table of Contents](#table-of-contents)
+  - [Reporting a vulnerability](#reporting-a-vulnerability)
+  - [General Security Enquiries](#general-security-enquiries)
+
+## Reporting a vulnerability
+
+If you believe you have found a security issue in this repository, please report it using GitHub's private vulnerability reporting:
+
+1. [Report a vulnerability](https://github.com/NHSDigital/clinical-data-gateway-api/security/advisories/new)
+2. Provide details of the issue and steps to reproduce
+
+This creates a private channel for discussion and allows us to coordinate a fix before any public disclosure.
+
+## General Security Enquiries
+
+If you have general enquiries regarding our cybersecurity, please reach out to us at [cybersecurity@nhs.net](cybersecurity@nhs.net)
diff --git a/bruno/gateway-api/collections/APIM/User_Info.yml b/bruno/gateway-api/collections/APIM/User_Info.yml
@@ -5,13 +5,15 @@ info:
 
 http:
   method: GET
-  url: https://internal-dev.api.service.nhs.uk/oauth2-mock/userinfo
+  url: https://{{host}}/oauth2-mock/userinfo
   auth:
     type: bearer
-    token: ""
+    token: "{{token}}"
 
 settings:
   encodeUrl: true
   timeout: 0
   followRedirects: true
   maxRedirects: 5
+
+docs: Use the `token` environment variable to set the Authorization header. Do not enter it directly into the header. This ensures that the value is never saved into git.
diff --git a/bruno/gateway-api/collections/APIM/environments/internal-dev.yml b/bruno/gateway-api/collections/APIM/environments/internal-dev.yml
@@ -0,0 +1,6 @@
+name: internal-dev
+variables:
+  - name: host
+    value: internal-dev.api.service.nhs.uk
+  - secret: true
+    name: token
diff --git a/gateway-api/src/fhir/constants.py b/gateway-api/src/fhir/constants.py
@@ -11,5 +11,4 @@ class FHIRSystem(StrEnum):
     SDS_USER_ID = "https://fhir.nhs.uk/Id/sds-user-id"
     SDS_ROLE_PROFILE_ID = "https://fhir.nhs.uk/Id/sds-role-profile-id"
     NHS_SERVICE_INTERACTION_ID = "https://fhir.nhs.uk/Id/nhsServiceInteractionId"
-    NHS_MHS_PARTY_KEY = "https://fhir.nhs.uk/Id/nhsMhsPartyKey"
     NHS_SPINE_ASID = "https://fhir.nhs.uk/Id/nhsSpineASID"
diff --git a/gateway-api/src/fhir/r4/__init__.py b/gateway-api/src/fhir/r4/__init__.py
@@ -4,7 +4,6 @@
 from .elements.identifier import (
     ASIDIdentifier,
     OrganizationIdentifier,
-    PartyKeyIdentifier,
     PatientIdentifier,
     UUIDIdentifier,
 )
@@ -25,7 +24,6 @@
     "GeneralPractitioner",
     "OrganizationIdentifier",
     "Organization",
-    "PartyKeyIdentifier",
     "Patient",
     "PatientIdentifier",
     "Practitioner",
diff --git a/gateway-api/src/fhir/r4/elements/identifier.py b/gateway-api/src/fhir/r4/elements/identifier.py
@@ -33,12 +33,6 @@ class ASIDIdentifier(Identifier, expected_system="https://fhir.nhs.uk/Id/nhsSpin
     """A FHIR R4 ASID Identifier."""
 
 
-class PartyKeyIdentifier(
-    Identifier, expected_system="https://fhir.nhs.uk/Id/nhsMhsPartyKey"
-):
-    """A FHIR R4 Party Key Identifier."""
-
-
 class AgnosticDeviceIdentifier(Identifier, expected_system="__unknown__"):
     """TODO [GPCAPIM-358]: define system once JWT Device details are understood."""
 
diff --git a/gateway-api/src/fhir/r4/resources/device.py b/gateway-api/src/fhir/r4/resources/device.py
@@ -7,7 +7,6 @@
 from ..elements.identifier import (
     AgnosticDeviceIdentifier,
     ASIDIdentifier,
-    PartyKeyIdentifier,
 )
 
 
@@ -17,6 +16,6 @@ class Device(Resource, resource_type="Device"):
     model_config = ConfigDict(extra="allow")
 
     identifier: Annotated[
-        list[ASIDIdentifier | PartyKeyIdentifier | AgnosticDeviceIdentifier],
+        list[ASIDIdentifier | AgnosticDeviceIdentifier],
         Field(frozen=True, min_length=1),
     ]
diff --git a/gateway-api/src/fhir/r4/resources/test_resources.py b/gateway-api/src/fhir/r4/resources/test_resources.py
@@ -12,7 +12,6 @@
     Entry,
     GeneralPractitioner,
     OrganizationIdentifier,
-    PartyKeyIdentifier,
     Patient,
     PatientIdentifier,
     Practitioner,
@@ -375,46 +374,11 @@ def test_create_with_asid_identifier(self) -> None:
             "identifier value should match"
         )
 
-    def test_create_with_party_key_identifier(self) -> None:
-        device = Device.create(
-            identifier=[
-                PartyKeyIdentifier(
-                    system="https://fhir.nhs.uk/Id/nhsMhsPartyKey",
-                    value="P12345-000001",
-                )
-            ],
-        )
-
-        assert device.identifier[0].system == "https://fhir.nhs.uk/Id/nhsMhsPartyKey", (
-            "system should match the party key URI"
-        )
-
-    def test_create_with_mixed_identifiers(self) -> None:
-        device = Device.create(
-            identifier=[
-                ASIDIdentifier(
-                    system="https://fhir.nhs.uk/Id/nhsSpineASID",
-                    value="123",
-                ),
-                PartyKeyIdentifier(
-                    system="https://fhir.nhs.uk/Id/nhsMhsPartyKey",
-                    value="PK-1",
-                ),
-            ],
-        )
-
-        assert len(device.identifier) == 2, "should have two identifiers"
-
     def test_asid_identifier_expected_system(self) -> None:
         assert ASIDIdentifier._expected_system == (
             "https://fhir.nhs.uk/Id/nhsSpineASID"
         ), "_expected_system should be the ASID URI"
 
-    def test_party_key_identifier_expected_system(self) -> None:
-        assert PartyKeyIdentifier._expected_system == (
-            "https://fhir.nhs.uk/Id/nhsMhsPartyKey"
-        ), "_expected_system should be the party key URI"
-
 
 class TestDeviceModelValidate:
     def test_valid_device(self) -> None:
diff --git a/gateway-api/src/gateway_api/get_structured_record/__init__.py b/gateway-api/src/gateway_api/get_structured_record/__init__.py
@@ -2,6 +2,7 @@
 
 from gateway_api.get_structured_record.request import (
     ACCESS_RECORD_STRUCTURED_INTERACTION_ID,
+    SDS_SANDBOX_INTERACTION_ID,
     GetStructuredRecordRequest,
 )
 from gateway_api.get_structured_record.response import GetStructuredRecordResponse
@@ -10,4 +11,5 @@
     "GetStructuredRecordRequest",
     "GetStructuredRecordResponse",
     "ACCESS_RECORD_STRUCTURED_INTERACTION_ID",
+    "SDS_SANDBOX_INTERACTION_ID",
 ]
diff --git a/gateway-api/src/gateway_api/get_structured_record/request.py b/gateway-api/src/gateway_api/get_structured_record/request.py
@@ -18,6 +18,11 @@
     "urn:nhs:names:services:gpconnect:fhir:operation:gpc.getstructuredrecord-1"
 )
 
+# The SDS Sandbox environment only returns results for this interaction ID.
+# Non-sandbox environments should use ACCESS_RECORD_STRUCTURED_INTERACTION_ID.
+# TODO: Remove this once we no longer support sandbox (probably in GPCAPIM-396).
+SDS_SANDBOX_INTERACTION_ID = "urn:nhs:names:services:psis:REPC_IN150016UK05"
+
 
 class GetStructuredRecordRequest:
     INTERACTION_ID: ClassVar[str] = ACCESS_RECORD_STRUCTURED_INTERACTION_ID
diff --git a/gateway-api/src/gateway_api/sds/client.py b/gateway-api/src/gateway_api/sds/client.py
@@ -19,7 +19,10 @@
 from requests import HTTPError
 
 from gateway_api.common.error import SdsRequestFailedError
-from gateway_api.get_structured_record import ACCESS_RECORD_STRUCTURED_INTERACTION_ID
+from gateway_api.get_structured_record import (
+    ACCESS_RECORD_STRUCTURED_INTERACTION_ID,
+    SDS_SANDBOX_INTERACTION_ID,
+)
 from gateway_api.sds.search_results import SdsSearchResults
 
 # TODO [GPCAPIM-359]: Once stub servers/containers made for PDS, SDS and provider
@@ -85,11 +88,18 @@ def __init__(
     ) -> None:
         self.base_url = base_url.rstrip("/")
         self.timeout = timeout
-        self.service_interaction_id = (
-            service_interaction_id or self.DEFAULT_SERVICE_INTERACTION_ID
-        )
         self.api_key = self._get_api_key()
 
+        if service_interaction_id is not None:
+            self.service_interaction_id = service_interaction_id
+        elif (
+            self.base_url
+            == "https://sandbox.api.service.nhs.uk/spine-directory/FHIR/R4"
+        ):
+            self.service_interaction_id = SDS_SANDBOX_INTERACTION_ID
+        else:
+            self.service_interaction_id = self.DEFAULT_SERVICE_INTERACTION_ID
+
         log_details = {
             "description": "Initialized SdsClient",
             "base_url": self.base_url,
@@ -140,9 +150,6 @@ def get_org_details(
             return empty_search_results
 
         asid = self._extract_device_identifier(device, FHIRSystem.NHS_SPINE_ASID)
-        party_key = self._extract_device_identifier(
-            device, FHIRSystem.NHS_MHS_PARTY_KEY
-        )
 
         # Step 2: Get Endpoint to obtain endpoint URL
         endpoint_url: str | None = None
@@ -152,7 +159,6 @@ def get_org_details(
 
         endpoint_bundle = self._query_sds(
             ods_code=ods_code,
-            party_key=party_key,
             correlation_id=correlation_id,
             timeout=timeout,
             querytype=SdsResourceType.ENDPOINT,
@@ -179,7 +185,6 @@ def _get_api_key() -> str:
     def _query_sds(
         self,
         ods_code: str,
-        party_key: str | None = None,
         correlation_id: str | None = None,
         timeout: int | None = 10,
         querytype: SdsResourceType = SdsResourceType.DEVICE,
@@ -197,9 +202,6 @@ def _query_sds(
             ],
         }
 
-        if party_key is not None:
-            params["identifier"].append(f"{FHIRSystem.NHS_MHS_PARTY_KEY}|{party_key}")
-
         log_details = {
             "description": "SDS request",
             "url": url,
diff --git a/gateway-api/src/gateway_api/sds/test_client.py b/gateway-api/src/gateway_api/sds/test_client.py
diff --git a/gateway-api/stubs/stubs/sds/stub.py b/gateway-api/stubs/stubs/sds/stub.py
diff --git a/gateway-api/tests/contract/stub/test_sds_stub_contract.py b/gateway-api/tests/contract/stub/test_sds_stub_contract.py

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,6 @@`
`7`	`7`	`from ..elements.identifier import (`
`8`	`8`	`AgnosticDeviceIdentifier,`
`9`	`9`	`ASIDIdentifier,`
`10`		`- PartyKeyIdentifier,`
`11`	`10`	`)`
`12`	`11`
`13`	`12`
`@@ -17,6 +16,6 @@ class Device(Resource, resource_type="Device"):`
`17`	`16`	`model_config = ConfigDict(extra="allow")`
`18`	`17`
`19`	`18`	`identifier: Annotated[`
`20`		`- list[ASIDIdentifier \| PartyKeyIdentifier \| AgnosticDeviceIdentifier],`
	`19`	`+ list[ASIDIdentifier \| AgnosticDeviceIdentifier],`
`21`	`20`	`Field(frozen=True, min_length=1),`
`22`	`21`	`]`