Accept only the API field names for OprfPseudonym

Author: thomas-samoht

app/models/pseudonym.py

@@ -10,10 +10,10 @@ class PseudonymResponse(BaseModel):
 
 
 class OprfPseudonym(BaseModel):
-    model_config = ConfigDict(frozen=True, validate_by_name=True)
+    model_config = ConfigDict(frozen=True)
 
-    jwe: str = Field(validation_alias="pseudonym")
-    blind_factor: str = Field(validation_alias="oprf_key")
+    jwe: str = Field(alias="pseudonym")
+    blind_factor: str = Field(alias="oprf_key")
 
 
 @dataclass

app/services/fhir/pseudonym_token.py

@@ -6,6 +6,6 @@
 def decode_pseudonym_token(token: str, field: str) -> OprfPseudonym:
     try:
         data = decode_url_safe_token(token)
-        return OprfPseudonym(jwe=data["evaluated_output"], blind_factor=data["blind_factor"])
+        return OprfPseudonym(pseudonym=data["evaluated_output"], oprf_key=data["blind_factor"])
     except Exception as exc:
         raise PseudonymError(f"Invalid pseudonym in {field}") from exc

tests/models/test_pseudonym.py

@@ -1,4 +1,7 @@
-from app.models.pseudonym import EncryptedPseudonym
+import pytest
+from pydantic import ValidationError
+
+from app.models.pseudonym import EncryptedPseudonym, OprfPseudonym
 
 
 def test_init_should_converts_value_to_string() -> None:
@@ -38,3 +41,13 @@ def test_inequality_should_succeed_with_different_value() -> None:
 def test_equality_should_return_false_when_compared_with_non_instance() -> None:
     pseudonym = EncryptedPseudonym("test", "mock")
     assert pseudonym != "test"
+
+
+def test_oprf_pseudonym_reads_the_api_field_names() -> None:
+    pseudonym = OprfPseudonym.model_validate({"pseudonym": "JWE", "oprf_key": "BF"})
+    assert (pseudonym.jwe, pseudonym.blind_factor) == ("JWE", "BF")
+
+
+def test_oprf_pseudonym_rejects_the_internal_field_names() -> None:
+    with pytest.raises(ValidationError):
+        OprfPseudonym.model_validate({"jwe": "JWE", "blind_factor": "BF"})

tests/services/fhir/test_pseudonym_token.py

@@ -17,7 +17,7 @@ def _encode(data: dict[str, str]) -> str:
 
 
 def test_decodes_evaluated_output_and_blind_factor() -> None:
-    assert decode_pseudonym_token(TEST_PSEUDONYM_TOKEN, FIELD) == OprfPseudonym(jwe="JWE", blind_factor="BF")
+    assert decode_pseudonym_token(TEST_PSEUDONYM_TOKEN, FIELD) == OprfPseudonym(pseudonym="JWE", oprf_key="BF")
 
 
 @pytest.mark.parametrize(

tests/services/test_crypto_service_api_client.py

@@ -7,7 +7,7 @@
 from app.models.pseudonym import OprfPseudonym, PseudonymResponse
 from app.services.crypto_service_api_client import CryptoServiceApiClient
 
-PSEUDONYM = OprfPseudonym(jwe="jwe", blind_factor="bf")
+PSEUDONYM = OprfPseudonym(pseudonym="jwe", oprf_key="bf")
 
 
 @pytest.fixture()
@@ -31,7 +31,7 @@ def test_exchange_returns_hashed_pseudonym(crypto_client: CryptoServiceApiClient
     http_mock.do_request.return_value = response
 
     result = crypto_client.exchange(
-        OprfPseudonym(jwe="some-jwe", blind_factor="some-blind-factor"), "some-label", "CBC_AES"
+        OprfPseudonym(pseudonym="some-jwe", oprf_key="some-blind-factor"), "some-label", "CBC_AES"
     )
 
     assert result == PseudonymResponse(encrypted_pseudonym="abc", iv="123")

tests/services/test_pseudonym_referral_service.py

@@ -17,8 +17,8 @@
 REQUESTING_URA = UraNumber("00000456")
 SOURCE = "SomeDevice"
 OTHER_SOURCE = "OtherDevice"
-PSEUDONYM = OprfPseudonym(jwe="JWE", blind_factor="BF")
-OTHER_PSEUDONYM = OprfPseudonym(jwe="OTHER", blind_factor="BF")
+PSEUDONYM = OprfPseudonym(pseudonym="JWE", oprf_key="BF")
+OTHER_PSEUDONYM = OprfPseudonym(pseudonym="OTHER", oprf_key="BF")
 
 
 class FailingCryptoClient(CryptoServiceApiClientMock):

tests/services/test_pseudonym_resolver.py

@@ -6,7 +6,7 @@
 from app.services.key_info import KeyInfoService
 from app.services.pseudonym_resolver import PseudonymResolver
 
-OPRF_PSEUDONYM = OprfPseudonym(jwe="JWE", blind_factor="BF")
+OPRF_PSEUDONYM = OprfPseudonym(pseudonym="JWE", oprf_key="BF")
 
 
 @pytest.fixture()