Shamira Changeset - 1e161ede44c5

Changeset - 1e161ede44c5

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Laman - 3 years ago 2022-03-03 17:39:53

updated readme.md

1 file changed with 22 insertions and 2 deletions:

readme.md

0 comments (0 inline, 0 general)

readme.md

➞

Show inline comments

 # Shamira #
 Implements [Shamir's secret sharing algorithm](https://en.wikipedia.org/wiki/Shamir's_Secret_Sharing). Splits a string or a byte sequence byte-per-byte into _n_<255 shares, with any _k_ of them sufficient for reconstruction of the original input.
 Outputs the shares as hexadecimal, Base32 or Base64 encoded strings.
 ## Installation and usage ##
 ## Installation ##
 ### From pip
 Run `pip install shamira`.
 ### From the source
 Can be run straight from the cloned repository by executing the package with `python -m shamira` or simply installed with `python setup.py build`, `python setup.py install`. Then imported in your code with `import shamira` or run from the command line with `shamira`.
 ## Usage
 Can be run straight from the cloned repository by executing the package with `python -m shamira` or simply installed with `python setup.py build`, `python setup.py install`. Then imported in your code with `import shamira` or run from the command line with `shamira`.
 ### As a CLI application
 Run `shamira split ...` for splitting and `shamira join ...` for joining the shares back. Appending `--help` will show you the documentation.
 ### As a library
 `from shamira import generate, generate_raw, reconstruct, reconstruct_raw`
 `help(function)` will show the documentation.
 ## Issue tracker
 Please report your issues to https://trac.19x19.cz/shamira/report
 ## Performance ##
 As it is, the code is not very fast. Let's assume we have a secret of length _m_. For each byte, the splitting takes _n_ evaluations of a polynomial of order _k_ over Galois field 256, leading to _O(n\*k\*m)_ finite field multiplications. Reconstruction of the constant parameters during joining takes _O(k\*k + k\*m)_ multiplications.
 Benchmark results, all values mean _seconds per byte_ of the secret length:
 <table>
     <tr>
         <th>k / n parameters</th>
         <th>Split</th>
         <th>Join</th>
     </tr>
     <tr>
         <td>2 / 3 (a Raspberry Pi 3)</td>
         <td>6.08e-05</td>
         <td>0.000435</td>
     </tr>
     <tr>
         <td>2 / 3 (a laptop)</td>
         <td>5.02e-06</td>
         <td>4.12e-05</td>
     </tr>
     <tr>
         <td>254 / 254 (a Raspberry Pi 3)</td>

0 comments (0 inline, 0 general)