Skip to content

Add warning for pose.cache security risks #521

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add warning for pose.cache security risks #521

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6f5cc7b
Add warning for pose.cache security risks
rclune Sep 17, 2025
cd676af
Updated pickle warning message
rclune Sep 23, 2025
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
5 changes: 5 additions & 0 deletions source/src/python/PyRosetta/src/pyrosetta/bindings/scores/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ class PoseCacheAccessor(PoseCacheAccessorBase, MutableMapping):
arbitrary python objects to/from base64-encoded pickled byte streams, and stores/retrieves `float` and `str`
objects without serialization.

**Warning**: ONLY LOAD DATA YOU TRUST. The pose.cache dictionary uses the pickle module to serialze and deserialize arbitrary scores in the Pose object.
When depickling (deserializing) is performed arbitrary code can be executed, learn more `here <https://docs.python.org/3/library/pickle.html>`_.
The pose.cache object is only stored in memory, so this is only a risk if these objects are sent to a user in memory over a network
such as a socket, queue, shared cache, etc. If you need to retrieve a pose.cache dictionary this way please make sure it is from a trusted source.

Examples:

Get score dictionaries:
Expand Down