Skip to content

Python: reject malformed checkpoint Base64 payloads #8262

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fzfzzfzzzfzzzz wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −1
Open

Python: reject malformed checkpoint Base64 payloads #8262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion python/packages/core/agent_framework/_workflows/_checkpoint_encoding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ def _base64_to_unpickle(encoded: str, *, allowed_types: frozenset[str] | None =
format is incompatible, or a disallowed type is encountered.
"""
try:
pickled = base64.b64decode(encoded.encode("ascii"))
pickled = base64.b64decode(encoded.encode("ascii"), validate=True)
if allowed_types is not None:
return _RestrictedUnpickler(pickled, allowed_types).load()
return pickle.loads(pickled) # nosec # ruff:ignore[suspicious-pickle-usage]
Expand Down
11 changes: 11 additions & 0 deletions python/packages/core/tests/workflow/test_checkpoint_decode.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

from agent_framework import WorkflowCheckpointException
from agent_framework._workflows._checkpoint_encoding import (
_PICKLE_MARKER, # type: ignore
_TYPE_MARKER, # type: ignore
decode_checkpoint_value,
encode_checkpoint_value,
Expand Down Expand Up @@ -188,6 +189,16 @@ def test_decode_raises_on_type_mismatch() -> None:
decode_checkpoint_value(encoded)


def test_decode_raises_on_malformed_base64() -> None:
"""Test that decoding rejects non-Base64 characters in a pickle payload."""
encoded = encode_checkpoint_value((1, 2, 3))
assert isinstance(encoded, dict)
encoded[_PICKLE_MARKER] = cast(str, encoded[_PICKLE_MARKER]) + "!!!!"

with pytest.raises(WorkflowCheckpointException, match="Failed to decode pickled checkpoint data"):
decode_checkpoint_value(encoded)


class NotADataclass: # noqa: B903
"""A regular class that is not a dataclass."""

Expand Down
Loading