Skip to main content

A CLI implementation of Shamir's secret sharing.

Project description

GreyTeamToolbox logo
Github Build Status License Created
Release Released Commits since release

Overview

Shamir's secret sharing (SSS) is an efficient secret sharing algorithm for distributing private information (the "secret") among a group. The secret cannot be revealed unless a quorum of the group acts together to pool their knowledge.

To achieve this, the secret is mathematically divided into parts (the "shares") from which the secret can be reassembled only when a sufficient number of shares are combined. SSS has the property of information-theoretic security, meaning that even if an attacker steals some shares, it is impossible for the attacker to reconstruct the secret unless they have stolen the quorum number of shares.

Installation

pip install wolfsoftware.shamir-secret-sharing

Command Line Usage

usage: shamir-secret-sharing [-h] [-V] [-s SHARES] [-t THRESHOLD] [-o] (-c CREATE | -r SHARE [SHARE ...])

Shamir's Secret Sharing CLI

flags:
  -h, --help            Show this help message and exit
  -V, --version         Show program's version number and exit.

optional:
  -s SHARES, --shares SHARES
                        Total number of shares to create (default: None)
  -t THRESHOLD, --threshold THRESHOLD
                        Threshold number of shares needed to reconstruct the secret (default: None)
  -o, --output          Output shares to screen instead of writing to files (default: False)

required:
  -c CREATE, --create CREATE
                        The secret to share or the file containing the secret (default: None)
  -r SHARE [SHARE ...], --reconstruct SHARE [SHARE ...]
                        List of shares in the form "x,y" or file paths ending with .txt (default: None)

Creating Shares

shamir-secret-sharing -c "mysupersecretpassword" -s 5 -t 3

Reconstructing the Secret

shamir-secret-sharing -r share-1.txt share-3.txt share-5.txt

Limitations

Secrets are limited to a max size of 4096 bytes. If you have a secret which is larger than that, then we recommend you split it into 4K blocks and then use this tool per block, and when you reconstruct the file parts then you can simply reconstruct the original file from there.

Splitting Large files

split -b 4096 original_file block_

Reconstructing the File from 4K Blocks

cat block_* > reconstructed_file

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file wolfsoftware_shamir_secret_sharing-0.1.3.tar.gz.

File metadata

File hashes

Hashes for wolfsoftware_shamir_secret_sharing-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d6cba19786c49bd979377d13aed725f48d482d720c92e84c8bf0ece1fb350b8f
MD5 eeec9f1385639abc012f95938c20541d
BLAKE2b-256 89a21f4b8666b6096f010361bad04725dfd1d049292bb7910a5abc4ba3d400c9

See more details on using hashes here.

File details

Details for the file wolfsoftware.shamir_secret_sharing-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for wolfsoftware.shamir_secret_sharing-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0e879ed15bb40b84952d0b7b38cab5350c19282ff49715060c56b83cb9602107
MD5 badd86cb702dc16233cbcc701c422db0
BLAKE2b-256 b96ea58d1d46ba8e7ae49f3299dea83dbda58ae7b0ef1c93a452cd3db584ddbb

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page