Start writing docs
This commit is contained in:
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
RSSSS — Rust Shamir Secret Sharing Scheme
|
||||||
|
===================================
|
||||||
|
|
||||||
|
This is an implementation of Shamir's secret sharing scheme, useful
|
||||||
|
for securely dividing a secret into parts, some number of which must
|
||||||
|
be present to recover the original secret.
|
||||||
|
|
||||||
|
Principle of Operation
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
Shamir's secret sharing scheme (S4) works by
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
cargo install rssss
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
@@ -52,7 +52,7 @@ use std::io;
|
|||||||
/// M34: (~1.2MBit) 2^1257787-1
|
/// M34: (~1.2MBit) 2^1257787-1
|
||||||
///
|
///
|
||||||
/// M19 should only be used for *extremely* secure sharing of RSA keys; M34
|
/// M19 should only be used for *extremely* secure sharing of RSA keys; M34
|
||||||
/// probably shouldn't be used at all. It will likely be extremely slow;
|
/// probably shouldn't be used at all. It will likely be unusably slow;
|
||||||
/// you should rather generate shares of an AES key and use that to encrypt your real secret
|
/// you should rather generate shares of an AES key and use that to encrypt your real secret
|
||||||
|
|
||||||
#[derive(StructOpt)]
|
#[derive(StructOpt)]
|
||||||
|
|||||||
Reference in New Issue
Block a user