Skip to content

Commit 92a28eb

Browse files
fix(parameters): handle invalid UTF-8 transform errors (#8609)
Signed-off-by: Oikantik Basu <140976895+Golden007-prog@users.noreply.github.com> Co-authored-by: Leandro Damascena <lcdama@amazon.pt>
1 parent 7188793 commit 92a28eb

2 files changed

Lines changed: 39 additions & 9 deletions

File tree

‎aws_lambda_powertools/utilities/parameters/base.py‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -334,9 +334,6 @@ def transform_value(
334334

335335
err_msg = "Unable to transform value using '{transform}' transform: {exc}"
336336

337-
if isinstance(value, bytes):
338-
value = value.decode("utf-8")
339-
340337
if isinstance(value, dict):
341338
# NOTE: We must handle partial failures when receiving multiple values
342339
# where one of the keys might fail during transform, e.g. `{"a": "valid", "b": "{"}`
@@ -353,14 +350,14 @@ def transform_value(
353350
transformed_values[dict_key] = None
354351
return transformed_values
355352

356-
if transform == "auto":
357-
# key="a.json", value='{"a": "b"}', or key="a.binary", value="b64_encoded"
358-
transform_method = get_transform_method(value=key, transform=transform)
359-
else:
360-
# value='{"key": "value"}
361-
transform_method = get_transform_method(value=value, transform=transform)
353+
# Auto transforms inspect the parameter name; explicit transforms ignore it.
354+
transform_method = get_transform_method(value=key, transform=transform)
362355

363356
try:
357+
# Identity transforms must preserve raw bytes. Decode failures belong to
358+
# the same error policy as JSON/base64 failures.
359+
if isinstance(value, bytes) and transform_method is not TRANSFORM_METHOD_MAPPING[None]:
360+
value = value.decode("utf-8")
364361
return transform_method(value)
365362
except Exception as exc:
366363
if raise_on_transform_error:

‎tests/functional/parameters/_boto3/test_utilities_parameters.py‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3302,6 +3302,39 @@ def _get_multiple(self, path: str, **kwargs) -> dict[str, str]:
33023302
assert value == mock_value
33033303

33043304

3305+
@pytest.mark.parametrize(
3306+
"transform,key",
3307+
[("binary", "secret"), ("json", "secret"), ("auto", "secret.binary"), ("auto", "secret.json")],
3308+
)
3309+
def test_transform_value_invalid_utf8_obeys_error_policy(transform, key):
3310+
value = b"\xff\xfe"
3311+
3312+
with pytest.raises(parameters.TransformParameterError) as excinfo:
3313+
parameters.base.transform_value(value, transform=transform, key=key)
3314+
3315+
assert isinstance(excinfo.value.__cause__, UnicodeDecodeError)
3316+
assert parameters.base.transform_value(value, transform=transform, key=key, raise_on_transform_error=False) is None
3317+
3318+
3319+
@pytest.mark.parametrize("value", [b"\xff\xfe", b"valid UTF-8"])
3320+
@pytest.mark.parametrize("key", ["secret", "secret.bin"])
3321+
def test_secret_provider_auto_preserves_unmatched_binary(value, key, config):
3322+
provider = parameters.SecretsProvider(boto_config=config)
3323+
with stub.Stubber(provider.client) as stubber:
3324+
stubber.add_response("get_secret_value", {"SecretBinary": value}, {"SecretId": key})
3325+
assert provider.get(key, transform="auto") == value
3326+
stubber.assert_no_pending_responses()
3327+
3328+
3329+
def test_secret_provider_invalid_utf8_raises_transform_error(config):
3330+
provider = parameters.SecretsProvider(boto_config=config)
3331+
with stub.Stubber(provider.client) as stubber:
3332+
stubber.add_response("get_secret_value", {"SecretBinary": b"\xff\xfe"}, {"SecretId": "secret"})
3333+
with pytest.raises(parameters.TransformParameterError):
3334+
provider.get("secret", transform="binary")
3335+
stubber.assert_no_pending_responses()
3336+
3337+
33053338
def test_appconf_get_app_config_different_environment_and_application(monkeypatch, mock_name):
33063339
# GIVEN a provider that reports which environment/application it was built for
33073340
class TestProvider(BaseProvider):

0 commit comments

Comments
 (0)