Skip to content

Clearly document that this package should never be used to store unsanitized user input. #69

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

Merged
charettes merged 1 commit into from
Oct 1, 2025
Merged

Clearly document that this package should never be used to store unsanitized user input. #69

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
16 changes: 16 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,22 @@ and assign whatever you like (as long as it's picklable) to the field:
>>> obj.args = ['fancy', {'objects': 'inside'}]
>>> obj.save()

.. warning::

As the name of this package implies ``django-picklefield`` relies on the
stdlib `pickle`_ module to serialize its data. Concretely this means that
**this package should not be used to store user controllable data under any
circumstances at the risk of exposing your application to arbitrary code
execution**.

In order to prevent potentially dangerous usage of ``PickledObjectField``
field it is explicitly marked as ``editable=False`` which will prevent its
declarative usage in forms and consequently the admin but be aware that
assigning unsanitized user provided strings directly to a ``PickledObjectField``
exposes your to arbitrary code execution the same way piping malicious
strings into ``pickle.loads`` does.

.. _pickle: https://docs.python.org/3/library/pickle.html#module-pickle

-----
Notes
Expand Down
Loading