@enclave-technologies/pqc-primitives 0.1.0

package/dist/web/enclave_pqc_primitives_wasm.d.ts

@@ -0,0 +1,284 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Canonical suite identifier matching the Rust crate (Category 5 algorithms).
+ */
+export function ENCLAVE_PQ_SUITE_ID(): string;
+
+/**
+ * Domain-separation prefix for the Enclave labeled KDF.
+ */
+export function KDF_LABEL_PREFIX(): string;
+
+/**
+ * Algorithm identifier (`"Argon2id"`).
+ */
+export function PWHASH_ALGORITHM(): string;
+
+/**
+ * Derived key length in bytes (matches AES-256-GCM key size).
+ */
+export function PWHASH_OUTPUT_BYTES(): number;
+
+/**
+ * Salt length in bytes produced by [`generate_salt`].
+ */
+export function PWHASH_SALT_BYTES(): number;
+
+/**
+ * OWASP baseline Argon2id params: `{ memoryCostKib, iterations, parallelism }`.
+ *
+ * Sourced from the OWASP Password Storage Cheat Sheet (19 MiB / t=2 / p=1).
+ * Slow and memory-hard by design — lowering these for login latency is a
+ * security tradeoff, not a free optimization.
+ */
+export function RECOMMENDED_PARAMS(): any;
+
+/**
+ * Decrypt AES-256-GCM ciphertext (including trailing tag).
+ *
+ * Throws on authentication failure (`AeadFailure: ...`).
+ */
+export function aeadDecrypt(key: Uint8Array, nonce: Uint8Array, ciphertext: Uint8Array, aad: Uint8Array): Uint8Array;
+
+/**
+ * Encrypt with AES-256-GCM under an explicit key and nonce.
+ *
+ * Returns `ciphertext || tag` (16-byte tag suffix). Callers must ensure
+ * `(key, nonce)` uniqueness.
+ */
+export function aeadEncrypt(key: Uint8Array, nonce: Uint8Array, plaintext: Uint8Array, aad: Uint8Array): Uint8Array;
+
+/**
+ * Cryptographically random 16-byte salt for Argon2id.
+ */
+export function generateSalt(): Uint8Array;
+
+/**
+ * Return the [`CryptoUsageRecord`] from the last WASM primitive call.
+ *
+ * Shape: `{ algorithm, suiteId, operation, crateVersion }`.
+ * Returns `undefined` if no operation has run yet in this WASM instance.
+ *
+ * This is the CBOM attach point for product layers (Encrypt, etc.). This
+ * binding does not persist or transmit the record.
+ */
+export function getLastUsageRecord(): any;
+
+/**
+ * SHAKE256 over UTF-8 string bytes.
+ */
+export function hashUtf8(value: string, output_len: number): Uint8Array;
+
+/**
+ * Decapsulate an ML-KEM-1024 ciphertext.
+ *
+ * `secret_key` may be a 64-byte seed or a 3168-byte expanded key.
+ */
+export function kemDecapsulate(ciphertext: Uint8Array, secret_key: Uint8Array): Uint8Array;
+
+/**
+ * Encapsulate a shared secret to an ML-KEM-1024 public key.
+ *
+ * Returns `{ ciphertext, sharedSecret }` (1568 / 32 bytes).
+ */
+export function kemEncapsulate(public_key: Uint8Array): any;
+
+/**
+ * Deterministic encapsulation for known-answer / KAT compliance.
+ *
+ * # Hazmat
+ *
+ * **KATs only.** Production code must call [`kem_encapsulate`].
+ */
+export function kemEncapsulateDeterministic(public_key: Uint8Array, m: Uint8Array): any;
+
+/**
+ * Expand a 64-byte seed-form secret key to the FIPS expanded encoding
+ * ([`kem::SECRET_KEY_BYTES`] bytes).
+ */
+export function kemExpandedSecretKey(secret_key: Uint8Array): Uint8Array;
+
+/**
+ * Generate a fresh ML-KEM-1024 keypair (includes PCT).
+ *
+ * Returns `{ publicKey, secretKey }` where `secretKey` is the preferred
+ * seed form ([`kem::SECRET_KEY_SEED_BYTES`] = 64). Expanded size is
+ * [`kem::SECRET_KEY_BYTES`] = 3168 — use [`kem_expanded_secret_key`].
+ *
+ * Throws `PairwiseConsistencyFailureError` if the PCT fails.
+ */
+export function kemGenerateKeypair(): any;
+
+/**
+ * Derive an ML-KEM-1024 keypair from a 64-byte seed (`d || z`). Includes PCT.
+ */
+export function kemKeypairFromSeed(seed: Uint8Array): any;
+
+/**
+ * Derive key material with `enclave-kdf-v1` labeled SHAKE256.
+ *
+ * Throws `InvalidParameter` on empty `label` or `length == 0`.
+ */
+export function labeledKdf(label: string, ikm: Uint8Array, length: number): Uint8Array;
+
+/**
+ * [`labeled_kdf`] with a 32-byte output.
+ */
+export function labeledKdf32(label: string, ikm: Uint8Array): Uint8Array;
+
+/**
+ * Derive a 32-byte key from a password + salt with Argon2id.
+ *
+ * `params` must be `{ memoryCostKib, iterations, parallelism }` (see
+ * [`recommended_params`]). Throws on empty password / wrong salt length /
+ * invalid costs.
+ *
+ * This call is intentionally slow (~tens–hundreds of ms depending on host).
+ * That cost is the offline brute-force defense — do not lower params casually.
+ */
+export function pwhashDeriveKey(password: Uint8Array, salt: Uint8Array, params: any): Uint8Array;
+
+/**
+ * Run known-answer CASTs for ML-KEM-1024, ML-DSA-87, and Argon2id.
+ *
+ * Throws `SelfTestFailureError` if any CAST fails. Pair-wise consistency is
+ * already enforced inside key generation — this is the power-on / module-entry
+ * known-answer path. The Argon2id CAST is slower (memory-hard by design).
+ */
+export function runSelfTests(): void;
+
+/**
+ * One-shot SHAKE256 hash of `input` into `output_len` bytes.
+ */
+export function shake256(input: Uint8Array, output_len: number): Uint8Array;
+
+/**
+ * Expand a 32-byte seed-form secret key to the FIPS expanded encoding
+ * ([`sig::SECRET_KEY_BYTES`] bytes).
+ */
+export function sigExpandedSecretKey(secret_key: Uint8Array): Uint8Array;
+
+/**
+ * Generate a fresh ML-DSA-87 keypair (includes PCT).
+ *
+ * Returns `{ publicKey, secretKey }` where `secretKey` is the preferred
+ * seed form ([`sig::SECRET_KEY_SEED_BYTES`] = 32). Expanded size is
+ * [`sig::SECRET_KEY_BYTES`] = 4896.
+ *
+ * Throws `PairwiseConsistencyFailureError` if the PCT fails.
+ */
+export function sigGenerateKeypair(): any;
+
+/**
+ * Derive an ML-DSA-87 keypair from a 32-byte seed. Includes PCT.
+ */
+export function sigKeypairFromSeed(seed: Uint8Array): any;
+
+/**
+ * Sign a message with empty context (deterministic ML-DSA-87).
+ *
+ * Empty `message` throws `InvalidLength` (matches Rust).
+ */
+export function sigSign(secret_key: Uint8Array, message: Uint8Array): Uint8Array;
+
+/**
+ * Deterministic ML-DSA.Sign with an explicit context (`context.len() <= 255`).
+ *
+ * Empty `message` or `context.len() > 255` throws (matches Rust).
+ */
+export function sigSignWithContext(secret_key: Uint8Array, message: Uint8Array, context: Uint8Array): Uint8Array;
+
+/**
+ * Verify an ML-DSA-87 signature (empty context).
+ *
+ * Returns `false` on a cryptographically invalid signature. Throws only for
+ * malformed input lengths / encodings.
+ */
+export function sigVerify(public_key: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean;
+
+/**
+ * Verify an ML-DSA-87 signature with an explicit context.
+ *
+ * Returns `false` on cryptographic failure; throws on malformed lengths.
+ */
+export function sigVerifyWithContext(public_key: Uint8Array, message: Uint8Array, signature: Uint8Array, context: Uint8Array): boolean;
+
+/**
+ * Overwrite a JS `Uint8Array` in place with zeros.
+ *
+ * # Security note
+ *
+ * Rust-side secret keys are zeroized on `Drop`, but that guarantee **does not**
+ * cross the WASM boundary. Once secret material lives in a JS `Uint8Array`, the
+ * JS garbage collector will not zero it. Call this when you are finished with
+ * long-lived secret buffers.
+ */
+export function zeroize(buf: Uint8Array): void;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly aeadDecrypt: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
+    readonly aeadEncrypt: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
+    readonly hashUtf8: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly shake256: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly sigExpandedSecretKey: (a: number, b: number) => [number, number, number, number];
+    readonly sigGenerateKeypair: () => [number, number, number];
+    readonly sigKeypairFromSeed: (a: number, b: number) => [number, number, number];
+    readonly sigSign: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly sigSignWithContext: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
+    readonly sigVerify: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number];
+    readonly sigVerifyWithContext: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number];
+    readonly PWHASH_ALGORITHM: () => [number, number];
+    readonly PWHASH_OUTPUT_BYTES: () => number;
+    readonly PWHASH_SALT_BYTES: () => number;
+    readonly RECOMMENDED_PARAMS: () => [number, number, number];
+    readonly generateSalt: () => [number, number, number, number];
+    readonly kemDecapsulate: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly kemEncapsulate: (a: number, b: number) => [number, number, number];
+    readonly kemEncapsulateDeterministic: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly kemExpandedSecretKey: (a: number, b: number) => [number, number, number, number];
+    readonly kemGenerateKeypair: () => [number, number, number];
+    readonly kemKeypairFromSeed: (a: number, b: number) => [number, number, number];
+    readonly pwhashDeriveKey: (a: number, b: number, c: number, d: number, e: any) => [number, number, number, number];
+    readonly ENCLAVE_PQ_SUITE_ID: () => [number, number];
+    readonly KDF_LABEL_PREFIX: () => [number, number];
+    readonly getLastUsageRecord: () => [number, number, number];
+    readonly labeledKdf: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly labeledKdf32: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly runSelfTests: () => [number, number];
+    readonly zeroize: (a: any) => void;
+    readonly __wbindgen_exn_store: (a: number) => void;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;