mii/RustySecrets
1
0
Fork 0
mirror of https://github.com/mii443/RustySecrets.git synced 2025-08-22 16:25:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add PR warning to the README

Browse Source
This commit is contained in:
Romain Ruetschi
2017-10-18 13:46:28 +02:00
committed by GitHub
parent 02c88e0164
commit a9e942a41a
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -5,6 +5,12 @@
[**Documentation (latest)**](https://docs.rs/rusty_secrets/)
[**Documentation (master)**](http://spinresearch.github.io/RustySecrets/rusty_secrets/index.html)
## Warning: Please do not send pull requests for the moment
> This library is currently being heavily refactored in a private branch, and as such, we are currently unable to merge pull requests against the master branch. We will release the changes in this private branch publicly as soon as we get them audited. Until then, we definitely welcome bug reports, constructive feedback, or features ideas. Feel free to send a PR though, if you don't mind seeing it closed, or indefinitely delayed.
> Thank you for checking out RustySecrets, we hope to be able to accept your contributions very soon!
## Design goals
The main use for this library is to split a secret of an arbitrary length in *n* different shares and *t*-out-of-*n* shares are required to recover it. The dealer is assumed to be honest (and competent). We further assume that our adversary will only be able to compromise at most *t-1* shares. Shares are kept offline.