@arcium-hq/client 0.9.1 → 0.9.3

package/build/types/cryptography/hkdf.d.ts

@@ -0,0 +1,37 @@
+import { HMACRescuePrime } from './hmac.js';
+import { FpField } from './rescueDesc.js';
+/**
+ * HKDF (HMAC-based Extract-and-Expand Key Derivation Function) using the Rescue-Prime hash function.
+ * Follows RFC 5869. Only supports L = HashLen.
+ */
+export declare class HKDFRescuePrime {
+    hmac: HMACRescuePrime;
+    /**
+     * Construct a new HKDFRescuePrime instance.
+     */
+    constructor(field: FpField);
+    /**
+     * HKDF-Extract step: derive a pseudorandom key (PRK) from the input keying material (IKM) and salt.
+     * @param salt - Salt value as an array of bigints.
+     * @param ikm - Input keying material as an array of bigints.
+     * @returns Pseudorandom key (PRK) as an array of bigints.
+     */
+    extract(salt: bigint[], ikm: bigint[]): bigint[];
+    /**
+     * HKDF-Expand step: expand the pseudorandom key (PRK) with info to produce output keying material (OKM).
+     * Only supports L = HashLen = 5, i.e. N = 1.
+     * @param prk - Pseudorandom key as an array of bigints.
+     * @param info - Context and application specific information as an array of bigints.
+     * @returns Output keying material (OKM) as an array of bigints.
+     */
+    expand(prk: bigint[], info: bigint[]): bigint[];
+    /**
+     * Perform the full HKDF (extract and expand) to derive output keying material (OKM).
+     * @param salt - Salt value as an array of bigints.
+     * @param ikm - Input keying material as an array of bigints.
+     * @param info - Context and application specific information as an array of bigints.
+     * @returns Output keying material (OKM) as an array of bigints.
+     */
+    okm(salt: bigint[], ikm: bigint[], info: bigint[]): bigint[];
+}
+//# sourceMappingURL=hkdf.d.ts.map

package/build/types/cryptography/hkdf.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hkdf.d.ts","sourceRoot":"","sources":["../../../src/cryptography/hkdf.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C;;;GAGG;AACH,qBAAa,eAAe;IACxB,IAAI,EAAE,eAAe,CAAC;IAEtB;;OAEG;gBACS,KAAK,EAAE,OAAO;IAI1B;;;;;OAKG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAQhD;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAQ/C;;;;;;OAMG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;CAI/D"}

package/build/types/cryptography/hmac.d.ts

@@ -0,0 +1,22 @@
+import { FpField } from './rescueDesc.js';
+import { RescuePrimeHash } from './rescuePrimeHash.js';
+/**
+ * HMACRescuePrime provides a message authentication code (MAC) using the Rescue-Prime hash function.
+ * We refer to https://datatracker.ietf.org/doc/html/rfc2104 for more details.
+ */
+export declare class HMACRescuePrime {
+    hasher: RescuePrimeHash;
+    /**
+     * Construct a new HMACRescuePrime instance.
+     */
+    constructor(field: FpField);
+    /**
+     * Compute the HMAC digest of a message with a given key using Rescue-Prime.
+     * @param key - Key as an array of bigints.
+     * @param message - Message as an array of bigints.
+     * @returns HMAC digest as an array of bigints.
+     * @throws Error if the key is shorter than the hash function's digest length or longer than the hash function's rate.
+     */
+    digest(key: bigint[], message: bigint[]): bigint[];
+}
+//# sourceMappingURL=hmac.d.ts.map

package/build/types/cryptography/hmac.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hmac.d.ts","sourceRoot":"","sources":["../../../src/cryptography/hmac.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAgBvD;;;GAGG;AACH,qBAAa,eAAe;IACxB,MAAM,EAAE,eAAe,CAAC;IAExB;;OAEG;gBACS,KAAK,EAAE,OAAO;IAI1B;;;;;;OAMG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;CA0BrD"}

package/build/types/cryptography/rescueCipher.d.ts

@@ -0,0 +1,29 @@
+import { RescueCipherCommon } from './rescueCipherCommon.js';
+/**
+ * The Rescue cipher over Curve25519's base field in Counter (CTR) mode, with a fixed block size m = 5.
+ * See: https://tosc.iacr.org/index.php/ToSC/article/view/8695/8287
+ */
+export declare class RescueCipher {
+    cipher: RescueCipherCommon;
+    /**
+     * Construct a RescueCipher instance using a shared secret.
+     * The key is derived using RescuePrimeHash and used to initialize the RescueDesc.
+     * @param sharedSecret - Shared secret to derive the cipher key from.
+     */
+    constructor(sharedSecret: Uint8Array);
+    /**
+     * Encrypt the plaintext vector in Counter (CTR) mode and serialize each block.
+     * @param plaintext - Array of plaintext bigints to encrypt.
+     * @param nonce - 16-byte nonce for CTR mode.
+     * @returns Ciphertext as an array of arrays of numbers (each 32 bytes).
+     */
+    encrypt(plaintext: bigint[], nonce: Uint8Array): number[][];
+    /**
+     * Deserialize and decrypt the ciphertext vector in Counter (CTR) mode.
+     * @param ciphertext - Array of arrays of numbers (each 32 bytes) to decrypt.
+     * @param nonce - 16-byte nonce for CTR mode.
+     * @returns Decrypted plaintext as an array of bigints.
+     */
+    decrypt(ciphertext: number[][], nonce: Uint8Array): bigint[];
+}
+//# sourceMappingURL=rescueCipher.d.ts.map

package/build/types/cryptography/rescueCipher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rescueCipher.d.ts","sourceRoot":"","sources":["../../../src/cryptography/rescueCipher.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;GAGG;AACH,qBAAa,YAAY;IACrB,MAAM,EAAE,kBAAkB,CAAC;IAE3B;;;;OAIG;gBACS,YAAY,EAAE,UAAU;IAIpC;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE,EAAE;IAI3D;;;;;OAKG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE;CAG/D"}

package/build/types/cryptography/rescueCipherCommon.d.ts

@@ -0,0 +1,45 @@
+import { RescueDesc, FpField } from './rescueDesc.js';
+/**
+ * The Rescue cipher in Counter (CTR) mode, with a fixed block size m = 5.
+ * See: https://tosc.iacr.org/index.php/ToSC/article/view/8695/8287
+ */
+export declare class RescueCipherCommon {
+    desc: RescueDesc;
+    /**
+     * Construct a RescueCipherCommon instance using a shared secret.
+     * The key is derived using RescuePrimeHash and used to initialize the RescueDesc.
+     * @param sharedSecret - Shared secret to derive the cipher key from.
+     */
+    constructor(sharedSecret: Uint8Array, field: FpField);
+    /**
+     * Encrypt the plaintext vector in Counter (CTR) mode (raw, returns bigints).
+     * @param plaintext - Array of plaintext bigints to encrypt.
+     * @param nonce - 16-byte nonce for CTR mode.
+     * @returns Ciphertext as an array of bigints.
+     * @throws Error if the nonce is not 16 bytes long.
+     */
+    encrypt_raw(plaintext: bigint[], nonce: Uint8Array): bigint[];
+    /**
+     * Encrypt the plaintext vector in Counter (CTR) mode and serialize each block.
+     * @param plaintext - Array of plaintext bigints to encrypt.
+     * @param nonce - 16-byte nonce for CTR mode.
+     * @returns Ciphertext as an array of arrays of numbers (each 32 bytes).
+     */
+    encrypt(plaintext: bigint[], nonce: Uint8Array): number[][];
+    /**
+     * Decrypt the ciphertext vector in Counter (CTR) mode (raw, expects bigints).
+     * @param ciphertext - Array of ciphertext bigints to decrypt.
+     * @param nonce - 16-byte nonce for CTR mode.
+     * @returns Decrypted plaintext as an array of bigints.
+     * @throws Error if the nonce is not 16 bytes long.
+     */
+    decrypt_raw(ciphertext: bigint[], nonce: Uint8Array): bigint[];
+    /**
+     * Deserialize and decrypt the ciphertext vector in Counter (CTR) mode.
+     * @param ciphertext - Array of arrays of numbers (each 32 bytes) to decrypt.
+     * @param nonce - 16-byte nonce for CTR mode.
+     * @returns Decrypted plaintext as an array of bigints.
+     */
+    decrypt(ciphertext: number[][], nonce: Uint8Array): bigint[];
+}
+//# sourceMappingURL=rescueCipherCommon.d.ts.map

package/build/types/cryptography/rescueCipherCommon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rescueCipherCommon.d.ts","sourceRoot":"","sources":["../../../src/cryptography/rescueCipherCommon.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,UAAU,EAEV,OAAO,EAEV,MAAM,iBAAiB,CAAC;AAoBzB;;;GAGG;AACH,qBAAa,kBAAkB;IAC3B,IAAI,EAAE,UAAU,CAAC;IAEjB;;;;OAIG;gBACS,YAAY,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO;IAuCpD;;;;;;OAMG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE;IAwC7D;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE,EAAE;IAI3D;;;;;;OAMG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE;IAqC9D;;;;;OAKG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE,KAAK,EAAE,UAAU,GAAG,MAAM,EAAE;CAQ/D"}

package/build/types/cryptography/rescueDesc.d.ts

@@ -0,0 +1,80 @@
+import { IField } from '@noble/curves/abstract/modular';
+import { Matrix } from '../matrix.js';
+/**
+ * Represents the operational mode for the Rescue cryptographic primitive.
+ * Can be either a block cipher mode with a key, or a hash function mode with parameters.
+ */
+type RescueMode = BlockCipher | HashFunction;
+/**
+ * Block cipher mode configuration for Rescue.
+ * Use a key for encryption/decryption operations.
+ */
+type BlockCipher = {
+    kind: 'cipher';
+    key: bigint[];
+};
+/**
+ * Hash function mode configuration for Rescue.
+ * @param m - Rate (number of field elements absorbed per round).
+ * @param capacity - Capacity (number of field elements in the state that are not directly accessible).
+ */
+type HashFunction = {
+    kind: 'hash';
+    m: number;
+    capacity: number;
+};
+/**
+ * Field type.
+ */
+export type FpField = IField<bigint>;
+/**
+ * Curve25519 base field as an IField instance.
+ */
+export declare const CURVE25519_BASE_FIELD: FpField;
+/**
+ * Curve25519 scalar field as an IField instance.
+ */
+export declare const CURVE25519_SCALAR_FIELD: FpField;
+/**
+ * Description and parameters for the Rescue cipher or hash function, including round constants, MDS matrix, and key schedule.
+ * See: https://tosc.iacr.org/index.php/ToSC/article/view/8695/8287
+ */
+export declare class RescueDesc {
+    mode: RescueMode;
+    field: FpField;
+    alpha: bigint;
+    alphaInverse: bigint;
+    nRounds: number;
+    m: number;
+    mdsMat: Matrix;
+    mdsMatInverse: Matrix;
+    roundKeys: Matrix[];
+    /**
+     * Construct a RescueDesc for a given field and mode (cipher or hash).
+     * Initialize round constants, MDS matrix, and key schedule.
+     * @param field - Field to use (e.g., CURVE25519_BASE_FIELD).
+     * @param mode - Mode: block cipher or hash function.
+     */
+    constructor(field: FpField, mode: RescueMode);
+    /**
+     * Sample round constants for the Rescue permutation, using SHAKE256.
+     * @param nRounds - Number of rounds.
+     * @returns Array of round constant matrices.
+     */
+    sampleConstants(nRounds: number): Matrix[];
+    /**
+     * Apply the Rescue permutation to a state matrix.
+     * @param state - Input state matrix.
+     * @returns Permuted state matrix.
+     */
+    permute(state: Matrix): Matrix;
+    /**
+     * Apply the inverse Rescue permutation to a state matrix.
+     * @param state - Input state matrix.
+     * @returns Inverse-permuted state matrix.
+     */
+    permuteInverse(state: Matrix): Matrix;
+}
+export declare function toVec(data: bigint[]): bigint[][];
+export {};
+//# sourceMappingURL=rescueDesc.d.ts.map

package/build/types/cryptography/rescueDesc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rescueDesc.d.ts","sourceRoot":"","sources":["../../../src/cryptography/rescueDesc.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAU,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAGtC;;;GAGG;AACH,KAAK,UAAU,GAAG,WAAW,GAAG,YAAY,CAAC;AAE7C;;;GAGG;AACH,KAAK,WAAW,GAAG;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,EAAE,CAAA;CAAE,CAAC;AAErD;;;;GAIG;AACH,KAAK,YAAY,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,OAA0B,CAAC;AAE/D;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,OAA0B,CAAC;AASjE;;;GAGG;AACH,qBAAa,UAAU;IACnB,IAAI,EAAE,UAAU,CAAC;IAEjB,KAAK,EAAE,OAAO,CAAC;IAGf,KAAK,EAAE,MAAM,CAAC;IAGd,YAAY,EAAE,MAAM,CAAC;IAErB,OAAO,EAAE,MAAM,CAAC;IAEhB,CAAC,EAAE,MAAM,CAAC;IAGV,MAAM,EAAE,MAAM,CAAC;IAGf,aAAa,EAAE,MAAM,CAAC;IAGtB,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;;;;OAKG;gBACS,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU;IAuD5C;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE;IAoF1C;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAW9B;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAUxC;AAqOD,wBAAgB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,EAAE,CAMhD"}

package/build/types/cryptography/rescuePrimeHash.d.ts

@@ -0,0 +1,23 @@
+import { RescueDesc, FpField } from './rescueDesc.js';
+/**
+ * The Rescue-Prime hash function, as described in https://eprint.iacr.org/2020/1143.pdf, offering 256 bits
+ * of security against collision, preimage and second-preimage attacks for any field of size at least 102 bits.
+ * We use the sponge construction with fixed rate = 7 and capacity = 5 (i.e., m = 12), and truncate the
+ * output to 5 field elements.
+ */
+export declare class RescuePrimeHash {
+    desc: RescueDesc;
+    rate: number;
+    digestLength: number;
+    /**
+     * Construct a RescuePrimeHash instance with rate = 7 and capacity = 5.
+     */
+    constructor(field: FpField);
+    /**
+     * Compute the Rescue-Prime hash of a message, with padding as described in Algorithm 2 of the paper.
+     * @param message - Input message as an array of bigints.
+     * @returns Hash output as an array of bigints (length = digestLength).
+     */
+    digest(message: bigint[]): bigint[];
+}
+//# sourceMappingURL=rescuePrimeHash.d.ts.map

package/build/types/cryptography/rescuePrimeHash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rescuePrimeHash.d.ts","sourceRoot":"","sources":["../../../src/cryptography/rescuePrimeHash.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,UAAU,EACV,OAAO,EACV,MAAM,iBAAiB,CAAC;AAGzB;;;;;GAKG;AACH,qBAAa,eAAe;IACxB,IAAI,EAAE,UAAU,CAAC;IAEjB,IAAI,EAAE,MAAM,CAAC;IAEb,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;gBACS,KAAK,EAAE,OAAO;IAgB1B;;;;OAIG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;CA4BtC"}

package/build/types/ctUtils.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Constant-time addition of two bigints, using 2's complement representation.
+ * @param x - First operand.
+ * @param y - Second operand.
+ * @param binSize - Number of bits to use in the operation.
+ * @returns Sum as a bigint.
+ */
+export declare function ctAdd(x: bigint, y: bigint, binSize: bigint): bigint;
+/**
+ * Constant-time subtraction of two bigints, using 2's complement representation.
+ * @param x - First operand.
+ * @param y - Second operand.
+ * @param binSize - Number of bits to use in the operation.
+ * @returns Difference as a bigint.
+ */
+export declare function ctSub(x: bigint, y: bigint, binSize: bigint): bigint;
+/**
+ * Return the sign bit of a bigint in constant time.
+ * @param x - Bigint to check.
+ * @param binSize - Bit position to check (typically the highest bit).
+ * @returns True if the sign bit is set, false otherwise.
+ */
+export declare function ctSignBit(x: bigint, binSize: bigint): boolean;
+/**
+ * Constant-time less-than comparison for two bigints.
+ * @param x - First operand.
+ * @param y - Second operand.
+ * @param binSize - Number of bits to use in the operation.
+ * @returns True if x < y, false otherwise.
+ */
+export declare function ctLt(x: bigint, y: bigint, binSize: bigint): boolean;
+/**
+ * Constant-time select between two bigints based on a boolean condition.
+ * @param b - Condition; if true, select x, otherwise select y.
+ * @param x - Value to select if b is true.
+ * @param y - Value to select if b is false.
+ * @param binSize - Number of bits to use in the operation.
+ * @returns Selected bigint.
+ */
+export declare function ctSelect(b: boolean, x: bigint, y: bigint, binSize: bigint): bigint;
+/**
+ * Check if a bigint fits in the range -2^binSize <= x < 2^binSize.
+ * Not constant-time for arbitrary x, but is constant-time for all inputs for which the function returns true.
+ * If you assert your inputs satisfy verifyBinSize(x, binSize), you need not care about the non constant-timeness of this function.
+ * @param x - Bigint to check.
+ * @param binSize - Number of bits to use in the check.
+ * @returns True if x fits in the range, false otherwise.
+ */
+export declare function verifyBinSize(x: bigint, binSize: bigint): boolean;
+//# sourceMappingURL=ctUtils.d.ts.map

package/build/types/ctUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ctUtils.d.ts","sourceRoot":"","sources":["../../src/ctUtils.ts"],"names":[],"mappings":"AAkDA;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAGnE;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAQnE;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAE7D;AAED;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEnE;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAElF;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAGjE"}