Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dennis-tra/shamir
🔑 A CLI frontend for Hashicorp Vault's Shamir's Secret Sharing implementation.
https://github.com/dennis-tra/shamir
apache2 cli golang hacktoberfest hashicorp hashicorp-vault shamir-secret-sharing vault
Last synced: about 2 hours ago
JSON representation
🔑 A CLI frontend for Hashicorp Vault's Shamir's Secret Sharing implementation.
- Host: GitHub
- URL: https://github.com/dennis-tra/shamir
- Owner: dennis-tra
- License: apache-2.0
- Created: 2022-05-16T19:28:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-10T16:19:27.000Z (about 1 year ago)
- Last Synced: 2024-10-02T23:10:09.247Z (about 16 hours ago)
- Topics: apache2, cli, golang, hacktoberfest, hashicorp, hashicorp-vault, shamir-secret-sharing, vault
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 23
- Watchers: 5
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shamir
[](https://github.com/RichardLitt/standard-readme)
A CLI frontend for [Hashicorp Vault's](https://www.vaultproject.io/) [Shamir's Secret Sharing](https://en.wikipedia.org/wiki/Shamir%27s_Secret_Sharing) [implementation](https://github.com/hashicorp/vault/tree/main/shamir). This allows you to split a secret into `x` shares, and then combine them back into a single secret using any `y` of those shares with `y <= x`.
```shell
$ shamir split secret.txt # default: split into 5 shares where you need any 3 to restore the secret (numbers configurable)
```
```shell
$ shamir restore shares.txt # shares.txt should contain at least 3 newline separated shares from above
```
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Background](#background)
- [Install](#install)
- [Usage](#usage)
- [Split](#split)
- [Restore](#restore)
- [Related Efforts](#related-efforts)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Background
Extra care needs to be taken when dealing with secrets. Therefore, this tiny tool is designed to be:
- **credible** - It uses [Hashicorp Vault's](https://github.com/hashicorp/vault/tree/main/shamir) Shamir's Secret Sharing implementation.
- **minimal** - It only uses Go's standard library besides the above dependency.
- **approachable** - The 131 [LoC](https://de.wikipedia.org/wiki/Lines_of_Code) should be quick and easy to audit yourself.
Further it's:
- **configurable** - You can configure the number of shares and the number of shares needed to restore the secret.
- **composable** - You can pipe [stdin](https://en.wikipedia.org/wiki/Standard_streams) to it and use it in scripts.
> *Write programs that do one thing and do it well.* - [Douglas McIlroy](https://en.wikipedia.org/wiki/Douglas_McIlroy)
## Install
When you are dealing with secrets I would recommend compiling the code yourself instead of relying on a binary distribution:
```shell
go install github.com/dennis-tra/shamir@latest
```
Make sure the `$GOPATH/bin` is in your `PATH` variable to access the installed `shamir` executable.
## Usage
### Split
Let's imagine you have confidential data in a file called `secret.txt`. You could then run any of the following commands:
```shell
$ shamir split secret.txt
$ shamir split -shares 10 -threshold 5 secret.txt
$ cat secret.txt | shamir split
```
The CLI exposes the following options:
- `-shares` - The number of shares to split the secret into.
- `-threshold` - The number of shares needed to restore the secret.
Example:
```shell
$ echo "My very secret secret." | shamir split -shares 4 -threshold 3
gU3GKbSg3CpSHtC+04y8OH9mtIdiq2tm
GXmZfZhoqRAgzGO+fULXEXfDusDJuCcX
ByQs4+phvdU2zXzMjYvjA+7qLLTke8Uk
9dV1XA0pJV2RDzLYh6qwKzjxJ+iBrd9W
```
Each line corresponds to one share of which you need any three to restore the original message.
To create separate files for each share, pipe `shamir` to the unix `split` command:
```shell
$ echo "My very secret secret." | shamir split -shares 4 -threshold 3 | split -l 1 - share_
```
`-l 1` means to split after each line, `-` means to use stdin and `share_` is the prefix for the files. The above command will create 4 files named `share_aa`, `share_ab`, `share_ac` and `share_ad`.
### Restore
Let's imagine you have a file called `shares.txt` which contains more than `threshold` shares of your secret **separated by newlines**. You could then run any of the following commands:
```shell
$ shamir restore shares.txt
$ cat shares.txt | shamir restore
```
Example:
```shell
$ echo "9dV1XA0pJV2RDzLYh6qwKzjxJ+iBrd9W\nByQs4+phvdU2zXzMjYvjA+7qLLTke8Uk" | shamir restore # not enough shares
VL_��n�!�m5��Π8
$ echo "9dV1XA0pJV2RDzLYh6qwKzjxJ+iBrd9W\nByQs4+phvdU2zXzMjYvjA+7qLLTke8Uk\ngU3GKbSg3CpSHtC+04y8OH9mtIdiq2tm" | shamir restore
My very secret secret.
```
Note the `\n` characters in the `echo` command to separate the shares from above. Share ordering is not relevant.
## Related Efforts
- [kinvolk/go-shamir](https://github.com/kinvolk/go-shamir) - A small CLI tool for Shamir's Secret Sharing written in Go, using Vault's Shamir implementation
## Maintainers
[@dennis-tra](https://github.com/dennis-tra).
## Contributing
Feel free to dive in! [Open an issue](https://github.com/RichardLitt/standard-readme/issues/new) or submit PRs.
## License
[Apache 2.0](LICENSE) © Dennis Trautwein