shamir

package

v0.0.4 Latest Latest Go to latest Published: Oct 17, 2023 License: MIT, MPL-2.0 Imports: 5 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/dkotik/kidwords

Links

Open Source Insights

Documentation ¶

Overview ¶

Package shamir implements Shamir Secret Sharing (SSS) scheme that splits a password into independent parts. This package is copied from HashiCorp vault in order to avoid adding a large dependency. Vault moved to BSL license on Aug 16, 2023, but this package remained with MPL-2.0 license, a copy of which is saved in the `./LICENSE` file.

Index ¶

Constants
func Combine(parts [][]byte) ([]byte, error)
func Split(secret []byte, parts, threshold int) ([][]byte, error)

Constants ¶

View Source

const (
	// ShareOverhead is the byte size overhead of each share
	// when using Split on a secret. This is caused by appending
	// a one byte tag to the share.
	ShareOverhead = 1
)

Variables ¶

This section is empty.

Functions ¶

func Combine ¶

func Combine(parts [][]byte) ([]byte, error)

Combine is used to reverse a Split and reconstruct a secret once a `threshold` number of parts are available.

func Split ¶

func Split(secret []byte, parts, threshold int) ([][]byte, error)

Split takes an arbitrarily long secret and generates a `parts` number of shares, `threshold` of which are required to reconstruct the secret. The parts and threshold must be at least 2, and less than 256. The returned shares are each one byte longer than the secret as they attach a tag used to reconstruct the secret.

Types ¶

This section is empty.

Source Files ¶

View all Source files

shamir.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL