Add SafePickleEncoder with restricted unpickler; deprecate PickleEncoder#849
Open
eddieran wants to merge 1 commit into
Open
Add SafePickleEncoder with restricted unpickler; deprecate PickleEncoder#849eddieran wants to merge 1 commit into
eddieran wants to merge 1 commit into
Conversation
PickleEncoder calls pickle.loads() without restrictions, enabling remote code execution when a broker is compromised (issue Bogdanp#848). This commit: - Adds SafePickleEncoder that uses a RestrictedUnpickler subclass, limiting deserialization to a fixed allow-list of safe built-in types (int, str, dict, list, datetime, UUID, Decimal, etc.). - Supports extension via extra_allowed parameter for custom types. - Adds a DeprecationWarning to PickleEncoder.decode() recommending SafePickleEncoder, with removal planned for dramatiq v3.0.0. - Exports SafePickleEncoder from the dramatiq top-level package. - Adds tests covering roundtrip encoding, RCE payload blocking, deprecation warning, extra_allowed, and stub broker integration. Closes Bogdanp#848
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #848 —
PickleEncodercallspickle.loads()without restrictions, enabling remote code execution via crafted pickle payloads when an attacker has broker access.This PR:
SafePickleEncoder— a drop-in replacement that uses aRestrictedUnpicklersubclass, limiting deserialization to a fixed allow-list of safe built-in types (int,str,dict,list,datetime,UUID,Decimal, etc.)extra_allowedparameter for projects that need custom typesPickleEncoder—decode()now emits aDeprecationWarningrecommendingSafePickleEncoder, with removal planned for v3.0.0SafePickleEncoderfrom the top-leveldramatiqpackageMigration
Test plan
os.system) are blocked withDecodeErrorextra_allowedparameter correctly extends the allow-listPickleEncoder.decode()emitsDeprecationWarningSafePickleEncoderis importable fromdramatiqtop-level