wolfsoftware.shamir-secret-sharing

A CLI implementation of Shamir's secret sharing.

https://github.com/greyteamtoolbox/shamir-secret-sharing-package

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.1%) to scientific vocabulary

Keywords

shamir-secret-sharing wolfsoftware
Last synced: 6 months ago · JSON representation ·

Repository

A CLI implementation of Shamir's secret sharing.

Basic Info
  • Host: GitHub
  • Owner: GreyTeamToolbox
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 243 KB
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 3
  • Releases: 5
Topics
shamir-secret-sharing wolfsoftware
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security

README.md

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

sh pip install wolfsoftware.shamir-secret-sharing

Command Line Usage

```sh usage: shamir-secret-sharing [-h] [-V] [-s SHARES] [-t THRESHOLD] -o

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

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

Reconstructing the Secret

sh 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

sh split -b 4096 original_file block_

Reconstructing the File from 4K Blocks

sh cat block_* > reconstructed_file


Owner

  • Name: Grey Team Toolbox
  • Login: GreyTeamToolbox
  • Kind: organization
  • Email: github@wolfsoftware.com

A collection of neutral security related tools. Created by Wolf Software.

Citation (CITATION.cff)

cff-version: 1.2.0
message: If you use this software, please cite it using these metadata.
title: Shamir's secret sharing
abstract: A CLI implementation of Shamir's secret sharing.
type: software
version: 0.1.3
date-released: 2024-07-01
repository-code: https://github.com/GreyTeamToolbox/shamir-secret-sharing-package
keywords:
  - "Wolf Software"
  - "Software"
license: MIT
authors:
  - family-names: "Wolf"
    orcid: "https://orcid.org/0009-0007-0983-2072"

GitHub Events

Total
  • Watch event: 1
  • Delete event: 84
  • Issue comment event: 171
  • Push event: 141
  • Pull request review event: 121
  • Pull request event: 167
  • Create event: 84
Last Year
  • Watch event: 1
  • Delete event: 84
  • Issue comment event: 171
  • Push event: 141
  • Pull request review event: 121
  • Pull request event: 167
  • Create event: 84

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 1
  • Total pull requests: 55
  • Average time to close issues: 14 days
  • Average time to close pull requests: 5 days
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 1.85
  • Merged pull requests: 37
  • Bot issues: 1
  • Bot pull requests: 55
Past Year
  • Issues: 1
  • Pull requests: 55
  • Average time to close issues: 14 days
  • Average time to close pull requests: 5 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 1.0
  • Average comments per pull request: 1.85
  • Merged pull requests: 37
  • Bot issues: 1
  • Bot pull requests: 55
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (116)
  • TGWolf (1)
Top Labels
Issue Labels
Pull Request Labels
dependabot: dependencies (116) dependabot: auto approve (87) dependabot: auto merge (87) dependabot: ecosystem : github actions (82) dependabot: ecosystem : python (34) dependabot: manual merge (18) resolution: closed (1) state: stale (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 43 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 4
  • Total maintainers: 1
pypi.org: wolfsoftware.shamir-secret-sharing

A CLI implementation of Shamir's secret sharing.

  • Versions: 4
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 43 Last month
Rankings
Dependent packages count: 10.9%
Average: 36.1%
Dependent repos count: 61.3%
Maintainers (1)
Last synced: 6 months ago

Dependencies

.github/workflows/cicd.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
.github/workflows/citation-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • citation-file-format/cffconvert-github-action 4cf11baa70a673bfdf9dad0acc7ee33b3f4b6084 composite
  • ruby/setup-ruby 943103cae7d3f1bb1e4951d5fcc7928b40e4b742 composite
.github/workflows/codeql.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • github/codeql-action/analyze a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
  • github/codeql-action/autobuild a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
  • github/codeql-action/init a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
.github/workflows/codeql.yml.old actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • github/codeql-action/analyze a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
  • github/codeql-action/autobuild a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
  • github/codeql-action/init a57c67b89589d2d13d5ac85a9fc4679c7539f94c composite
.github/workflows/delete-old-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • Mattraks/delete-workflow-runs 39f0bbed25d76b34de5594dceab824811479e5de composite
.github/workflows/dependabot.yml actions
  • dependabot/fetch-metadata 5e5f99653a5b510e8555840e80cbf1514ad4af38 composite
.github/workflows/document-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-node 60edb5dd545a775178f52524783378180af0d1f8 composite
  • ruby/setup-ruby 943103cae7d3f1bb1e4951d5fcc7928b40e4b742 composite
.github/workflows/generate-release.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • softprops/action-gh-release 69320dbe05506a9a39fc8ae11030b214ec2d1f87 composite
.github/workflows/generate-test-release.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • Bullrich/generate-release-changelog 6b60f004b4bf12ff271603dc32dbd261965ad2f2 composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
  • softprops/action-gh-release 69320dbe05506a9a39fc8ae11030b214ec2d1f87 composite
.github/workflows/greetings.yml actions
  • actions/first-interaction 34f15e814fe48ac9312ccf29db4e74fa767cbab7 composite
.github/workflows/purge-deprecated-workflow-runs.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • otto-de/purge-deprecated-workflow-runs 31a4e821d43e9a354cbd65845922c76e4b4b3633 composite
.github/workflows/repository-validation.yml actions
  • ActionsToolbox/get-language-versions-action 446919617fd774095b5dd3ed71c39dd3fd0d8f4f composite
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • actions/setup-go cdcb36043654635271a94b9a6d1392de5bb323a7 composite
  • actions/setup-python 82c7e631bb3cdc910f68e0081d67478d79c6982d composite
.github/workflows/security-hardening.yml actions
  • actions/checkout a5ac7e51b41094c92402da3b24376905380afc29 composite
  • zgosalvez/github-actions-ensure-sha-pinned-actions 40e45e738b3cad2729f599d8afc6ed02184e1dbd composite
.github/workflows/stale.yml actions
  • Gamesight/slack-workflow-status 68bf00d0dbdbcb206c278399aa1ef6c14f74347a composite
  • actions/stale 28ca1036281a5e5922ead5184a1bbf96e5fc984e composite
requirements.txt pypi
  • colorama ==0.4.6
  • setuptools ==70.0.0
  • wolfsoftware.notify ==0.1.0
setup.py pypi