https://github.com/simonfrey/s4

Simple Shamir's Secret Sharing (s4) - A go package giving a easy to use interface for the shamir's secret sharing algorithm
https://github.com/simonfrey/s4

hacktoberfest

Last synced: 15 days ago
JSON representation

Simple Shamir's Secret Sharing (s4) - A go package giving a easy to use interface for the shamir's secret sharing algorithm

• Host: GitHub
• URL: https://github.com/simonfrey/s4
• Owner: simonfrey
• License: mit
• Created: 2020-06-14T18:27:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-06T17:03:39.000Z (9 months ago)
• Last Synced: 2024-08-29T18:33:25.077Z (4 months ago)
• Topics: hacktoberfest
• Language: Go
• Homepage: https://simon-frey.com/s4
• Size: 1.53 MB
• Stars: 142
• Watchers: 3
• Forks: 19
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Shamir's Secret Sharing (s4)

With **S**imple **S**hamir's **S**ecret **S**haring (s4) I want to provide you an easy to use interface for this beautiful little piece of math.

Please note that s4 is provided as it is and I do not take responsibility for any bugs. s4 is a tiny layer around [hashicorp vault shamir](https://github.com/hashicorp/vault) and golang's [AES encryption](https://github.com/gtank/cryptopasta/blob/master/encrypt.go).

## 📚 Usage as library

You can use s4 as normal go library in your go projects by importing it via `import "github.com/simonfrey/s4"` and en-/decrypt

bytes to byte shares and vice versa

## 🏠 Building the WASM for the frontend

I assume you have a [go](https://golang.org/) build environment setup in your machine. 

In order to build & pack the web assembly file for the frontend please use the following command in the top level directory:

```

./build.sh

```

This will build you the required file. You now can copy to `build` folder to your web server (or use it locally) and it

should run s4 as intended.

### Building the frontend in Docker (in case you don't have a [go](https://golang.org/) build environment setup in your machine.)

```

docker run --rm -v .:/app docker.io/golang:1.14 env --chdir=/app -S ./build.sh

```

`docker` can also be replaced with `podman` in the above command, if you prefer to use it.

Find the frontend in the `build/` directory, containing all resources in-line.  

## 💸 Report Bugs & Tip

Please use [Github Issues](https://github.com/simonfrey/s4/issues) in order to report bugs

💸 If you want to tip me for my work on this project [feel free to do so](https://simon-frey.com/tip) 💸

## 🗣 Discussions

s4 was broadly discussed on [HackerNews](https://news.ycombinator.com/item?id=23541949), and was mentioned in [golang weekly](https://golangweekly.com/issues/317) in June 2020.

## 📃 License

[MIT License](https://github.com/simonfrey/s4/blob/master/LICENSE)