# goSecretSharing

**Repository Path**: panda-yan/goSecretSharing

## Basic Information

- **Project Name**: goSecretSharing
- **Description**: 秘密共享算法
https://www.nuomiphp.com/github/zh/64d9b653936c4d7a6d438772.html
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-11-24
- **Last Updated**: 2023-11-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# goSecretSharing

go-secret-sharing is a Golang package that implements Shamir's Secret Sharing (SSS) algorithm, specifically designed to work with mnemonics and string secrets. It allows you to split a secret into n number of shares such that a specified number (t) of those shares are required to recover the original secret.

The design of this tool was inspired by Ava Labs' [mnemonic-shamir-secret-sharing-cli](https://github.com/ava-labs/mnemonic-shamir-secret-sharing-cli).

# Features

- Implements Shamir's Secret Sharing algorithm for string secrets and mnemonics.
- Customize the number of shares and threshold required to reconstruct the secret.
- Provides cryptographic security for the shares generated.
- Optimized for performance and scalability.

## Installation

```go
  go get github.com/pakt-world/goSecretSharing
```

## Usage

```go
  import (
    "fmt"

    goSecretSharing "github.com/pakt-world/goSecretSharing"
  )

  func main(){
    secretText := "Hello World"
    noOfShares := 5
    noRequiredShares := 2
    // split secret
    splitedStrings, sErr := goSecretSharing.SplitSecret(secretText, noOfShares, noRequiredShares)
    if sErr != nil {
      fmt.Println("Spliting Error===", sErr)
    }
    recoveryString := []string{splitedStrings[1], splitedStrings[2]}
    // recover splitedStrings
    recoveredSecret, rErr := goSecretSharing.RecoverSecret(recString)
    if rErr != nil {
      fmt.Println("Recovery Error===", rErr)
    }
    fmt.Println("Recovered Secret==", recoveredSecret)
  }
```

## Contributing

We welcome contributions from the open-source community. Please fork the repository and submit a pull request to contribute to this project.

## License

This project is licensed under the  Apache-2.0 license. See the LICENSE file for details.

## Acknowledgements

- Thanks to Adi Shamir for the SSS algorithm.
- Thanks to Ava Labs for inspiring this project.

## Contact

If you have any questions or issues, please open an issue on this repository, or contact the maintainer directly.