Simple, independently audited, zero-dependency TypeScript implementation of Shamir's Secret Sharing algorithm
npm install shamir-secret-sharingSimple, independently audited, zero-dependency TypeScript implementation of Shamir's Secret Sharing algorithm.
Uses GF(2^8). Works on Uint8Array objects. Implementation inspired by hashicorp/vault.
Both Node and browser environments are supported.
Made with ❤️ by Privy.
This library has been independently audited by Cure53 (audit report) and Zellic (audit report).
There are a couple of considerations for proper use of this library.
1. Resistance to side channel attacks: JavaScript is a garbage-collected, just-in-time compiled language and it is thus unrealistic to achieve true constant-time guarantees. Where possible, we aim to achieve algorithmic constant-time.
2. This library is not responsible for verifying the result of share reconstruction. Incorrect or corrupted shares will produce an incorrect value. Thus, it is the responsibility of users of this library to verify the integrity of the reconstructed secret.
3. Secrets should ideally be uniformly distributed at random. If this is not the case, it is recommended to first encrypt the value and split the encryption key.
We can split a secret into shares and later combine the shares to reconstruct the secret.
``typescript
import {split, combine} from 'shamir-secret-sharing';
const toUint8Array = (data: string) => new TextEncoder().encode(data);
// Example of splitting user input
const input = document.querySelector("input#secret").value.normalize('NFKC');
const secret = toUint8Array(input);
const [share1, share2, share3] = await split(secret, 3, 2);
const reconstructed = await combine([share1, share3]);
console.log(btoa(reconstructed) === btoa(secret)); // true
// Example of splitting random entropy
const randomEntropy = crypto.getRandomValues(new Uint8Array(16));
const [share1, share2, share3] = await split(randomEntropy, 3, 2);
const reconstructed = await combine([share2, share3]);
console.log(btoa(reconstructed) === btoa(randomEntropy)); // true
// Example of splitting symmetric key
const key = await crypto.subtle.generateKey(
{
name: "AES-GCM",
length: 256
},
true,
["encrypt", "decrypt"]
);
const exportedKeyBuffer = await crypto.subtle.exportKey('raw', key);
const exportedKey = new Uint8Array(exportedKeyBuffer);
const [share1, share2, share3] = await split(exportedKey, 3, 2);
const reconstructed = await combine([share2, share1]);
console.log(btoa(reconstructed) === btoa(exportedKey)); // true
`
This package exposes two functions: split and combine.
#### split
`tssecret
/**
* Splits a into shares number of shares, requiring threshold of them to reconstruct secret.secret
*
* @param secret The secret value to split into shares.
* @param shares The total number of shares to split into. Must be at least 2 and at most 255.secret
* @param threshold The minimum number of shares required to reconstruct . Must be at least 2 and at most 255.shares
* @returns A list of shares.`
*/
declare function split(secret: Uint8Array, shares: number, threshold: number): Promise
#### combine
`tsshares
/**
* Combines to reconstruct the secret.``
*
* @param shares A list of shares to reconstruct the secret from. Must be at least 2 and at most 255.
* @returns The reconstructed secret.
*/
declare function combine(shares: Uint8Array[]): Promise
The shamir-secret-sharing library is not currently open to external contributions.
Please submit an Issue and fill
out the issue with as much information as possible if you have found a bug in need of
fixing.
You can also submit an Issue to
request new features, or to suggest changes to existing features.
Apache-2.0. See the license file.