matrix-org / matrix-org/vodozemac
Add docs that explain how to securely pickle things
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 399
- Forks
- 67
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 11
Description
One could leave private key data in memory if the pickling is used as just a dumb serialization. We should add examples and docs warning about this pitfal.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing documentation and examples covering pickling or serialization in the repository. Add examples and a clear warning about retaining private key data in memory when pickling is used as simple serialization, then verify that the documentation explains the security pitfall.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cryptography, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100