renamed the resolver parameter

Author: sufyankhanrao

apimatic_core/security/signature_verification/hmac_signature_verifier.py

@@ -45,7 +45,7 @@ class HmacSignatureVerifier(SignatureVerifier):
         Shared secret used for HMAC.
     signature_header : str
         Header name containing the provided signature (case-insensitive lookup).
-    message_resolver : Optional[Callable[[Request], Union[bytes, str, None]]]
+    canonical_message_builder : Optional[Callable[[Request], Union[bytes, str, None]]]
         Function that produces the exact message to sign. If omitted (None) or returns None,
         the verifier will use request.raw_body (bytes) if present, otherwise request.body (text, UTF-8).
     hash_alg : Callable (defaults to hashlib.sha256)
@@ -62,7 +62,7 @@ def __init__(
         *,
         key: str,
         signature_header: str,
-        message_resolver: Optional[Callable[[Request], Union[bytes, str, None]]] = None,
+        canonical_message_builder: Optional[Callable[[Request], Union[bytes, str, None]]] = None,
         hash_alg=hashlib.sha256,
         encoder: Optional[DigestEncoder] = None,
         signature_value_template: Optional[str] = None,
@@ -74,7 +74,7 @@ def __init__(
 
         self._key_bytes = key.encode("utf-8")
         self._signature_header_lc = signature_header.lower().strip()
-        self._message_resolver = message_resolver
+        self._message_resolver = canonical_message_builder
         self._hash_alg = hash_alg
         self._encoder = encoder or HexEncoder()
         self._signature_value_template = signature_value_template

tests/apimatic_core/security/signature_verification/test_hmac_signature_verifier.py

@@ -213,7 +213,7 @@ def test_hmac_verifier_happy(self, header_name, resolver, hash_alg, encoder, svt
         verifier = HmacSignatureVerifier(
             key=key,
             signature_header=header_name,
-            message_resolver=resolver,
+            canonical_message_builder=resolver,
             hash_alg=hash_alg,
             encoder=encoder,
             signature_value_template=svt,
@@ -237,7 +237,7 @@ def test_none_resolver_uses_raw_body(self, enc_hex):
         verifier = HmacSignatureVerifier(
             key=key,
             signature_header=header,
-            message_resolver=None,  # triggers raw_body fallback
+            canonical_message_builder=None,  # triggers raw_body fallback
             encoder=enc_hex,
         )
         # raw_body present; body intentionally different
@@ -257,7 +257,7 @@ def test_resolver_returning_none_uses_raw_body(self, enc_hex):
         verifier = HmacSignatureVerifier(
             key=key,
             signature_header=header,
-            message_resolver=resolve_none_returns_none,  # returns None => fallback
+            canonical_message_builder=resolve_none_returns_none,  # returns None => fallback
             encoder=enc_hex,
         )
         req = Request(headers={}, body='{"a": 1}', raw_body=b'{"a":1}')
@@ -276,7 +276,7 @@ def test_fallback_uses_text_body_when_no_raw_body(self, enc_hex):
         verifier = HmacSignatureVerifier(
             key=key,
             signature_header=header,
-            message_resolver=None,  # no resolver
+            canonical_message_builder=None,  # no resolver
             encoder=enc_hex,
         )
         req = Request(headers={}, body='{"z":2}')  # no raw_body
@@ -298,7 +298,7 @@ def test_signature_header_lookup_is_case_insensitive(self, variant_header, enc_h
         verifier = HmacSignatureVerifier(
             key=key,
             signature_header=header,
-            message_resolver=resolve_body,
+            canonical_message_builder=resolve_body,
             encoder=enc_hex,
         )
         req = Request(headers={}, body="{}")
@@ -312,7 +312,7 @@ def test_constant_signature_literal_accepted(self, enc_hex, req_minimal):
         verifier = HmacSignatureVerifier(
             key=key,
             signature_header=header,
-            message_resolver=resolve_body,
+            canonical_message_builder=resolve_body,
             encoder=enc_hex,
             signature_value_template="CONST",
         )
@@ -332,7 +332,7 @@ def test_missing_signature_header_fails(self, req_json_device, enc_hex):
         verifier = HmacSignatureVerifier(
             key="k-missing",
             signature_header="X-Missing",
-            message_resolver=resolve_body,
+            canonical_message_builder=resolve_body,
             encoder=enc_hex,
         )
         res = verifier.verify(req_json_device)
@@ -342,7 +342,7 @@ def test_blank_signature_header_fails(self, enc_hex):
         verifier = HmacSignatureVerifier(
             key="k-blank",
             signature_header="X-Blank",
-            message_resolver=resolve_body,
+            canonical_message_builder=resolve_body,
             encoder=enc_hex,
         )
         req = Request(headers={"X-Blank": "   "}, body="{}")
@@ -353,7 +353,7 @@ def test_signature_mismatch_fails(self, enc_hex):
         verifier = HmacSignatureVerifier(
             key="k-mismatch",
             signature_header="X-Sig",
-            message_resolver=resolve_body,
+            canonical_message_builder=resolve_body,
             encoder=enc_hex,
         )
         req = Request(headers={"X-Sig": "wrong"}, body="{}")
@@ -372,7 +372,7 @@ def test_verify_handles_encoder_exception(self, req_json_device):
         verifier = HmacSignatureVerifier(
             key="k-enc-boom",
             signature_header="X-Err",
-            message_resolver=resolve_body,
+            canonical_message_builder=resolve_body,
             encoder=self.ExplodingEncoder(),
         )
         req_json_device.headers = {"X-Err": "anything"}
@@ -383,7 +383,7 @@ def test_verify_handles_hash_exception(self, req_json_device, enc_hex):
         verifier = HmacSignatureVerifier(
             key="k-hash-boom",
             signature_header="X-Err",
-            message_resolver=resolve_body,
+            canonical_message_builder=resolve_body,
             hash_alg=self.ExplodingHash(),
             encoder=enc_hex,
         )
@@ -398,7 +398,7 @@ def bad_resolver(_req: Request):
         verifier = HmacSignatureVerifier(
             key="k-bad",
             signature_header="X-Sig",
-            message_resolver=bad_resolver,
+            canonical_message_builder=bad_resolver,
         )
         req = Request(headers={"X-Sig": "anything"}, body="{}")
         res = verifier.verify(req)