@bcts/shamir 1.0.0-alpha.10

package/dist/index.d.cts

@@ -0,0 +1,179 @@
+import { RandomNumberGenerator } from "@bcts/rand";
+
+//#region src/error.d.ts
+/**
+ * Error types for Shamir secret sharing operations.
+ */
+declare enum ShamirErrorType {
+  SecretTooLong = "SecretTooLong",
+  TooManyShares = "TooManyShares",
+  InterpolationFailure = "InterpolationFailure",
+  ChecksumFailure = "ChecksumFailure",
+  SecretTooShort = "SecretTooShort",
+  SecretNotEvenLen = "SecretNotEvenLen",
+  InvalidThreshold = "InvalidThreshold",
+  SharesUnequalLength = "SharesUnequalLength",
+}
+/**
+ * Error class for Shamir secret sharing operations.
+ */
+declare class ShamirError extends Error {
+  readonly type: ShamirErrorType;
+  constructor(type: ShamirErrorType, message?: string);
+  private static defaultMessage;
+}
+type ShamirResult<T> = T;
+//#endregion
+//#region src/shamir.d.ts
+/**
+ * Splits a secret into shares using the Shamir secret sharing algorithm.
+ *
+ * @param threshold - The minimum number of shares required to reconstruct the
+ *   secret. Must be greater than or equal to 1 and less than or equal to
+ *   shareCount.
+ * @param shareCount - The total number of shares to generate. Must be at least
+ *   threshold and less than or equal to MAX_SHARE_COUNT.
+ * @param secret - A Uint8Array containing the secret to be split. Must be at
+ *   least MIN_SECRET_LEN bytes long and at most MAX_SECRET_LEN bytes long.
+ *   The length must be an even number.
+ * @param randomGenerator - An implementation of the RandomNumberGenerator
+ *   interface, used to generate random data.
+ * @returns An array of Uint8Array representing the shares of the secret.
+ * @throws ShamirError if parameters are invalid
+ *
+ * @example
+ * ```typescript
+ * import { splitSecret } from "@bcts/shamir";
+ * import { SecureRandomNumberGenerator } from "@bcts/rand";
+ *
+ * const threshold = 2;
+ * const shareCount = 3;
+ * const secret = new TextEncoder().encode("my secret belongs to me.");
+ * const rng = new SecureRandomNumberGenerator();
+ *
+ * const shares = splitSecret(threshold, shareCount, secret, rng);
+ * console.log(shares.length); // 3
+ * ```
+ */
+declare function splitSecret(threshold: number, shareCount: number, secret: Uint8Array, randomGenerator: RandomNumberGenerator): Uint8Array[];
+/**
+ * Recovers the secret from the given shares using the Shamir secret sharing
+ * algorithm.
+ *
+ * @param indexes - An array of indexes of the shares to be used for recovering
+ *   the secret. These are the indexes of the shares returned by splitSecret.
+ * @param shares - An array of shares of the secret matching the indexes in
+ *   indexes. These are the shares returned by splitSecret.
+ * @returns A Uint8Array representing the recovered secret.
+ * @throws ShamirError if parameters are invalid or checksum verification fails
+ *
+ * @example
+ * ```typescript
+ * import { recoverSecret } from "@bcts/shamir";
+ *
+ * const indexes = [0, 2];
+ * const shares = [
+ *   new Uint8Array([47, 165, 102, 232, ...]),
+ *   new Uint8Array([221, 174, 116, 201, ...]),
+ * ];
+ *
+ * const secret = recoverSecret(indexes, shares);
+ * console.log(new TextDecoder().decode(secret)); // "my secret belongs to me."
+ * ```
+ */
+declare function recoverSecret(indexes: number[], shares: Uint8Array[]): Uint8Array;
+//#endregion
+//#region src/hazmat.d.ts
+/**
+ * Convert an array of bytes into a bitsliced representation.
+ * Takes the first 32 bytes from x and produces 8 u32 values.
+ *
+ * @param r - Output array of 8 u32 values (bitsliced representation)
+ * @param x - Input array of at least 32 bytes
+ */
+declare function bitslice(r: Uint32Array, x: Uint8Array): void;
+/**
+ * Convert a bitsliced representation back to bytes.
+ *
+ * @param r - Output array of at least 32 bytes
+ * @param x - Input array of 8 u32 values (bitsliced representation)
+ */
+declare function unbitslice(r: Uint8Array, x: Uint32Array): void;
+/**
+ * Set all 32 positions in a bitsliced array to the same byte value.
+ *
+ * @param r - Output array of 8 u32 values
+ * @param x - Byte value to set in all positions
+ */
+declare function bitsliceSetall(r: Uint32Array, x: number): void;
+/**
+ * Add (XOR) r with x and store the result in r.
+ * In GF(2^8), addition is XOR.
+ *
+ * @param r - First operand and result
+ * @param x - Second operand
+ */
+declare function gf256Add(r: Uint32Array, x: Uint32Array): void;
+/**
+ * Safely multiply two bitsliced polynomials in GF(2^8) reduced by
+ * x^8 + x^4 + x^3 + x + 1. r and a may overlap, but overlapping of r
+ * and b will produce an incorrect result! If you need to square a polynomial
+ * use gf256Square instead.
+ *
+ * @param r - Result array (8 u32 values)
+ * @param a - First operand (may overlap with r)
+ * @param b - Second operand (must NOT overlap with r)
+ */
+declare function gf256Mul(r: Uint32Array, a: Uint32Array, b: Uint32Array): void;
+/**
+ * Square x in GF(2^8) and write the result to r.
+ * r and x may overlap.
+ *
+ * @param r - Result array (8 u32 values)
+ * @param x - Value to square
+ */
+declare function gf256Square(r: Uint32Array, x: Uint32Array): void;
+/**
+ * Invert x in GF(2^8) and write the result to r.
+ *
+ * @param r - Result array (8 u32 values)
+ * @param x - Value to invert (will be modified)
+ */
+declare function gf256Inv(r: Uint32Array, x: Uint32Array): void;
+//#endregion
+//#region src/interpolate.d.ts
+/**
+ * Safely interpolate the polynomial going through
+ * the points (x0 [y0_0 y0_1 y0_2 ... y0_31]) , (x1 [y1_0 ...]), ...
+ *
+ * where
+ *   xi points to [x0 x1 ... xn-1 ]
+ *   y contains an array of pointers to 32-bit arrays of y values
+ *   y contains [y0 y1 y2 ... yn-1]
+ *   and each of the yi arrays contain [yi_0 yi_i ... yi_31].
+ *
+ * @param n - Number of points to interpolate
+ * @param xi - x coordinates for points (array of length n)
+ * @param yl - Length of y coordinate arrays
+ * @param yij - Array of n arrays of length yl
+ * @param x - Coordinate to interpolate at
+ * @returns The interpolated result of length yl
+ */
+declare function interpolate(n: number, xi: Uint8Array, yl: number, yij: Uint8Array[], x: number): Uint8Array;
+//#endregion
+//#region src/index.d.ts
+/**
+ * The minimum length of a secret.
+ */
+declare const MIN_SECRET_LEN = 16;
+/**
+ * The maximum length of a secret.
+ */
+declare const MAX_SECRET_LEN = 32;
+/**
+ * The maximum number of shares that can be generated from a secret.
+ */
+declare const MAX_SHARE_COUNT = 16;
+//#endregion
+export { MAX_SECRET_LEN, MAX_SHARE_COUNT, MIN_SECRET_LEN, ShamirError, ShamirErrorType, type ShamirResult, bitslice, bitsliceSetall, gf256Add, gf256Inv, gf256Mul, gf256Square, interpolate, recoverSecret, splitSecret, unbitslice };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/error.ts","../src/shamir.ts","../src/hazmat.ts","../src/interpolate.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;AAKY,aAAA,eAAA;EAcC,aAAA,GAAY,eAAA;EACR,aAAA,GAAA,eAAA;EAEG,oBAAA,GAAA,sBAAA;EAHa,eAAA,GAAA,iBAAA;EAAK,cAAA,GAAA,gBAAA;EA+B1B,gBAAY,GAAA,kBAAO;;;;ACU/B;;;AAKG,cD9CU,WAAA,SAAoB,KAAA,CC8C9B;EAAU,SAAA,IAAA,ED7CI,eC6CJ;EAkFG,WAAA,CAAA,IAAa,ED7HT,eC6HqC,EAAA,OAAyB,CAAV,EAAA,MAAU;;;KDjGtE,kBAAkB;;;;;AA7C9B;AAcA;;;;;AA+BA;;;;ACUA;;;;;AAuFA;;;;ACvIA;AAyBA;AAyBA;AAsBA;AAoBA;;;;;AA6GgB,iBDzJA,WAAA,CCyJe,SAAgB,EAAA,MAAA,EAAW,UAAA,EAAA,MAAA,EAAA,MAAA,EDtJhD,UCsJgD,EAAA,eAAA,EDrJvC,qBCqJuC,CAAA,EDpJvD,UCoJuD,EAAA;AA+C1D;;;;AC3JA;;;;;;;;AC3FA;AAKA;AAKA;;;;;;;;;;;iBH2HgB,aAAA,4BAAyC,eAAe;;;;;;AD9IxE;AAcA;;;AAAiC,iBEPjB,QAAA,CFOiB,CAAA,EEPL,WFOK,EAAA,CAAA,EEPW,UFOX,CAAA,EAAA,IAAA;;AA+BjC;;;;ACUA;AAGU,iBC1BM,UAAA,CD0BN,CAAA,EC1BoB,UD0BpB,EAAA,CAAA,EC1BmC,WD0BnC,CAAA,EAAA,IAAA;;;;AAoFV;;;iBCrFgB,cAAA,IAAkB;AAlDlC;AAyBA;AAyBA;AAsBA;AAoBA;;;AAA4D,iBApB5C,QAAA,CAoB4C,CAAA,EApBhC,WAoBgC,EAAA,CAAA,EApBhB,WAoBgB,CAAA,EAAA,IAAA;;AA6G5D;AA+CA;;;;AC3JA;;;;AAMa,iBDPG,QAAA,CCOH,CAAA,EDPe,WCOf,EAAA,CAAA,EDP+B,WCO/B,EAAA,CAAA,EDP+C,WCO/C,CAAA,EAAA,IAAA;;;;ACjGb;AAKA;AAKA;;iBF6LgB,WAAA,IAAe,gBAAgB;;;;;;;iBA+C/B,QAAA,IAAY,gBAAgB;;;;;;AF/P5C;AAcA;;;;;AA+BA;;;;ACUA;;;;AAKa,iBEwCG,WAAA,CFxCH,CAAA,EAAA,MAAA,EAAA,EAAA,EE0CP,UF1CO,EAAA,EAAA,EAAA,MAAA,EAAA,GAAA,EE4CN,UF5CM,EAAA,EAAA,CAAA,EAAA,MAAA,CAAA,EE8CV,UF9CU;;;;;;AD5DD,cISC,cAAA,GJTc,EAAA;AAc3B;;;AAAiC,cIApB,cAAA,GJAoB,EAAA;;AA+BjC;;cI1Ba,eAAA"}

package/dist/index.d.mts

@@ -0,0 +1,179 @@
+import { RandomNumberGenerator } from "@bcts/rand";
+
+//#region src/error.d.ts
+/**
+ * Error types for Shamir secret sharing operations.
+ */
+declare enum ShamirErrorType {
+  SecretTooLong = "SecretTooLong",
+  TooManyShares = "TooManyShares",
+  InterpolationFailure = "InterpolationFailure",
+  ChecksumFailure = "ChecksumFailure",
+  SecretTooShort = "SecretTooShort",
+  SecretNotEvenLen = "SecretNotEvenLen",
+  InvalidThreshold = "InvalidThreshold",
+  SharesUnequalLength = "SharesUnequalLength",
+}
+/**
+ * Error class for Shamir secret sharing operations.
+ */
+declare class ShamirError extends Error {
+  readonly type: ShamirErrorType;
+  constructor(type: ShamirErrorType, message?: string);
+  private static defaultMessage;
+}
+type ShamirResult<T> = T;
+//#endregion
+//#region src/shamir.d.ts
+/**
+ * Splits a secret into shares using the Shamir secret sharing algorithm.
+ *
+ * @param threshold - The minimum number of shares required to reconstruct the
+ *   secret. Must be greater than or equal to 1 and less than or equal to
+ *   shareCount.
+ * @param shareCount - The total number of shares to generate. Must be at least
+ *   threshold and less than or equal to MAX_SHARE_COUNT.
+ * @param secret - A Uint8Array containing the secret to be split. Must be at
+ *   least MIN_SECRET_LEN bytes long and at most MAX_SECRET_LEN bytes long.
+ *   The length must be an even number.
+ * @param randomGenerator - An implementation of the RandomNumberGenerator
+ *   interface, used to generate random data.
+ * @returns An array of Uint8Array representing the shares of the secret.
+ * @throws ShamirError if parameters are invalid
+ *
+ * @example
+ * ```typescript
+ * import { splitSecret } from "@bcts/shamir";
+ * import { SecureRandomNumberGenerator } from "@bcts/rand";
+ *
+ * const threshold = 2;
+ * const shareCount = 3;
+ * const secret = new TextEncoder().encode("my secret belongs to me.");
+ * const rng = new SecureRandomNumberGenerator();
+ *
+ * const shares = splitSecret(threshold, shareCount, secret, rng);
+ * console.log(shares.length); // 3
+ * ```
+ */
+declare function splitSecret(threshold: number, shareCount: number, secret: Uint8Array, randomGenerator: RandomNumberGenerator): Uint8Array[];
+/**
+ * Recovers the secret from the given shares using the Shamir secret sharing
+ * algorithm.
+ *
+ * @param indexes - An array of indexes of the shares to be used for recovering
+ *   the secret. These are the indexes of the shares returned by splitSecret.
+ * @param shares - An array of shares of the secret matching the indexes in
+ *   indexes. These are the shares returned by splitSecret.
+ * @returns A Uint8Array representing the recovered secret.
+ * @throws ShamirError if parameters are invalid or checksum verification fails
+ *
+ * @example
+ * ```typescript
+ * import { recoverSecret } from "@bcts/shamir";
+ *
+ * const indexes = [0, 2];
+ * const shares = [
+ *   new Uint8Array([47, 165, 102, 232, ...]),
+ *   new Uint8Array([221, 174, 116, 201, ...]),
+ * ];
+ *
+ * const secret = recoverSecret(indexes, shares);
+ * console.log(new TextDecoder().decode(secret)); // "my secret belongs to me."
+ * ```
+ */
+declare function recoverSecret(indexes: number[], shares: Uint8Array[]): Uint8Array;
+//#endregion
+//#region src/hazmat.d.ts
+/**
+ * Convert an array of bytes into a bitsliced representation.
+ * Takes the first 32 bytes from x and produces 8 u32 values.
+ *
+ * @param r - Output array of 8 u32 values (bitsliced representation)
+ * @param x - Input array of at least 32 bytes
+ */
+declare function bitslice(r: Uint32Array, x: Uint8Array): void;
+/**
+ * Convert a bitsliced representation back to bytes.
+ *
+ * @param r - Output array of at least 32 bytes
+ * @param x - Input array of 8 u32 values (bitsliced representation)
+ */
+declare function unbitslice(r: Uint8Array, x: Uint32Array): void;
+/**
+ * Set all 32 positions in a bitsliced array to the same byte value.
+ *
+ * @param r - Output array of 8 u32 values
+ * @param x - Byte value to set in all positions
+ */
+declare function bitsliceSetall(r: Uint32Array, x: number): void;
+/**
+ * Add (XOR) r with x and store the result in r.
+ * In GF(2^8), addition is XOR.
+ *
+ * @param r - First operand and result
+ * @param x - Second operand
+ */
+declare function gf256Add(r: Uint32Array, x: Uint32Array): void;
+/**
+ * Safely multiply two bitsliced polynomials in GF(2^8) reduced by
+ * x^8 + x^4 + x^3 + x + 1. r and a may overlap, but overlapping of r
+ * and b will produce an incorrect result! If you need to square a polynomial
+ * use gf256Square instead.
+ *
+ * @param r - Result array (8 u32 values)
+ * @param a - First operand (may overlap with r)
+ * @param b - Second operand (must NOT overlap with r)
+ */
+declare function gf256Mul(r: Uint32Array, a: Uint32Array, b: Uint32Array): void;
+/**
+ * Square x in GF(2^8) and write the result to r.
+ * r and x may overlap.
+ *
+ * @param r - Result array (8 u32 values)
+ * @param x - Value to square
+ */
+declare function gf256Square(r: Uint32Array, x: Uint32Array): void;
+/**
+ * Invert x in GF(2^8) and write the result to r.
+ *
+ * @param r - Result array (8 u32 values)
+ * @param x - Value to invert (will be modified)
+ */
+declare function gf256Inv(r: Uint32Array, x: Uint32Array): void;
+//#endregion
+//#region src/interpolate.d.ts
+/**
+ * Safely interpolate the polynomial going through
+ * the points (x0 [y0_0 y0_1 y0_2 ... y0_31]) , (x1 [y1_0 ...]), ...
+ *
+ * where
+ *   xi points to [x0 x1 ... xn-1 ]
+ *   y contains an array of pointers to 32-bit arrays of y values
+ *   y contains [y0 y1 y2 ... yn-1]
+ *   and each of the yi arrays contain [yi_0 yi_i ... yi_31].
+ *
+ * @param n - Number of points to interpolate
+ * @param xi - x coordinates for points (array of length n)
+ * @param yl - Length of y coordinate arrays
+ * @param yij - Array of n arrays of length yl
+ * @param x - Coordinate to interpolate at
+ * @returns The interpolated result of length yl
+ */
+declare function interpolate(n: number, xi: Uint8Array, yl: number, yij: Uint8Array[], x: number): Uint8Array;
+//#endregion
+//#region src/index.d.ts
+/**
+ * The minimum length of a secret.
+ */
+declare const MIN_SECRET_LEN = 16;
+/**
+ * The maximum length of a secret.
+ */
+declare const MAX_SECRET_LEN = 32;
+/**
+ * The maximum number of shares that can be generated from a secret.
+ */
+declare const MAX_SHARE_COUNT = 16;
+//#endregion
+export { MAX_SECRET_LEN, MAX_SHARE_COUNT, MIN_SECRET_LEN, ShamirError, ShamirErrorType, type ShamirResult, bitslice, bitsliceSetall, gf256Add, gf256Inv, gf256Mul, gf256Square, interpolate, recoverSecret, splitSecret, unbitslice };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/error.ts","../src/shamir.ts","../src/hazmat.ts","../src/interpolate.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;AAKY,aAAA,eAAA;EAcC,aAAA,GAAY,eAAA;EACR,aAAA,GAAA,eAAA;EAEG,oBAAA,GAAA,sBAAA;EAHa,eAAA,GAAA,iBAAA;EAAK,cAAA,GAAA,gBAAA;EA+B1B,gBAAY,GAAA,kBAAO;;;;ACU/B;;;AAKG,cD9CU,WAAA,SAAoB,KAAA,CC8C9B;EAAU,SAAA,IAAA,ED7CI,eC6CJ;EAkFG,WAAA,CAAA,IAAa,ED7HT,eC6HqC,EAAA,OAAyB,CAAV,EAAA,MAAU;;;KDjGtE,kBAAkB;;;;;AA7C9B;AAcA;;;;;AA+BA;;;;ACUA;;;;;AAuFA;;;;ACvIA;AAyBA;AAyBA;AAsBA;AAoBA;;;;;AA6GgB,iBDzJA,WAAA,CCyJe,SAAgB,EAAA,MAAA,EAAW,UAAA,EAAA,MAAA,EAAA,MAAA,EDtJhD,UCsJgD,EAAA,eAAA,EDrJvC,qBCqJuC,CAAA,EDpJvD,UCoJuD,EAAA;AA+C1D;;;;AC3JA;;;;;;;;AC3FA;AAKA;AAKA;;;;;;;;;;;iBH2HgB,aAAA,4BAAyC,eAAe;;;;;;AD9IxE;AAcA;;;AAAiC,iBEPjB,QAAA,CFOiB,CAAA,EEPL,WFOK,EAAA,CAAA,EEPW,UFOX,CAAA,EAAA,IAAA;;AA+BjC;;;;ACUA;AAGU,iBC1BM,UAAA,CD0BN,CAAA,EC1BoB,UD0BpB,EAAA,CAAA,EC1BmC,WD0BnC,CAAA,EAAA,IAAA;;;;AAoFV;;;iBCrFgB,cAAA,IAAkB;AAlDlC;AAyBA;AAyBA;AAsBA;AAoBA;;;AAA4D,iBApB5C,QAAA,CAoB4C,CAAA,EApBhC,WAoBgC,EAAA,CAAA,EApBhB,WAoBgB,CAAA,EAAA,IAAA;;AA6G5D;AA+CA;;;;AC3JA;;;;AAMa,iBDPG,QAAA,CCOH,CAAA,EDPe,WCOf,EAAA,CAAA,EDP+B,WCO/B,EAAA,CAAA,EDP+C,WCO/C,CAAA,EAAA,IAAA;;;;ACjGb;AAKA;AAKA;;iBF6LgB,WAAA,IAAe,gBAAgB;;;;;;;iBA+C/B,QAAA,IAAY,gBAAgB;;;;;;AF/P5C;AAcA;;;;;AA+BA;;;;ACUA;;;;AAKa,iBEwCG,WAAA,CFxCH,CAAA,EAAA,MAAA,EAAA,EAAA,EE0CP,UF1CO,EAAA,EAAA,EAAA,MAAA,EAAA,GAAA,EE4CN,UF5CM,EAAA,EAAA,CAAA,EAAA,MAAA,CAAA,EE8CV,UF9CU;;;;;;AD5DD,cISC,cAAA,GJTc,EAAA;AAc3B;;;AAAiC,cIApB,cAAA,GJAoB,EAAA;;AA+BjC;;cI1Ba,eAAA"}