Skip to content

docs: document the security model (pickle loading, security policy) - #841

Open
milton-minervino wants to merge 2 commits into
MAIF:developfrom
milton-minervino:docs/pickle-load-warning
Open

milton-minervino wants to merge 2 commits into
MAIF:developfrom
milton-minervino:docs/pickle-load-warning

Conversation

@milton-minervino

@milton-minervino milton-minervino commented Nov 19, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

SmartExplainer.load, load_smartpredictor and load_pickle unpickle the file they are given, which can run arbitrary code. Their docstrings now carry a Warnings section saying to load only files you created or trust.

Shapash is meant to reload pickles the user saved (like joblib.load or torch.load), so the behaviour itself stays the same. The two public loaders' warnings also say that their type and manifest checks run only after unpickling, so they offer no protection.

This PR also adds a SECURITY.md at the repo root that:

  • asks for vulnerabilities to be reported privately through GitHub instead of in public issues;
  • says only the latest minor release gets security fixes, with no guaranteed response times;
  • lists what is unsafe by design and therefore out of scope: loading pickled explainers, trust_remote_code=True, exposing the unauthenticated webapp, and the data embedded in HTML reports.

Docs-only change, no behaviour change.

Closes #807 (CodeQL CWE-502 findings)

SmartExplainer.load, load_smartpredictor and load_pickle unpickle the given file, which can run arbitrary code. Their docstrings now say to load only files you created or trust, and that the type and manifest checks run after unpickling, so they offer no protection.
@milton-minervino milton-minervino added the documentation Improvements or additions to documentation label Nov 19, 2026
Explain how to report a vulnerability privately through GitHub, and what counts as one. Loading a pickled explainer, trust_remote_code=True and
exposing the unauthenticated webapp are unsafe by design, so they are listed as such and reports about them are out of scope.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@milton-minervino milton-minervino changed the title docs: warn that loading pickled explainers can execute code docs: document the security model (pickle loading, security policy) Nov 19, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Security] Automated static analysis findings for MAIF/shapash (academic research)

1 participant