@oqs/liboqs-js 0.15.0

package/package.json

@@ -0,0 +1,108 @@
+{
+  "name": "@oqs/liboqs-js",
+  "version": "0.15.0",
+  "description": "Post-quantum cryptography for Node.js and browsers via WebAssembly bindings to liboqs",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/types/index.d.ts",
+  "sideEffects": false,
+  "bin": {
+    "liboqs": "./bin/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./src/types/index.d.ts",
+      "import": "./src/index.js"
+    },
+    "./kem": {
+      "types": "./src/types/index.d.ts",
+      "import": "./src/kem.js"
+    },
+    "./sig": {
+      "types": "./src/types/index.d.ts",
+      "import": "./src/sig.js"
+    },
+    "./errors": {
+      "types": "./src/types/errors.d.ts",
+      "import": "./src/core/errors.js"
+    }
+  },
+  "files": [
+    "src/",
+    "bin/",
+    "dist/"
+  ],
+  "scripts": {
+    "build": "./build.sh",
+    "build:single": "./build.sh",
+    "docs": "typedoc",
+    "typecheck": "tsc --noEmit",
+    "test": "bun run typecheck && bun run test:node && bun run test:browser",
+    "test:node": "vitest run",
+    "test:browser": "TEST_ENV=browser vitest run",
+    "test:watch": "vitest",
+    "test:cli": "vitest run tests/cli.test.ts",
+    "test:kem": "vitest run tests/kem.test.ts",
+    "test:sig": "vitest run tests/sig.test.ts",
+    "clean": "./build.sh --clean"
+  },
+  "keywords": [
+    "post-quantum",
+    "cryptography",
+    "pqc",
+    "liboqs",
+    "wasm",
+    "webassembly",
+    "quantum-resistant",
+    "nist",
+    "kem",
+    "signature",
+    "digital-signature",
+    "key-encapsulation",
+    "ml-kem",
+    "ml-dsa",
+    "kyber",
+    "dilithium",
+    "falcon",
+    "slh-dsa",
+    "classic-mceliece",
+    "frodokem",
+    "ntru",
+    "hqc",
+    "cross",
+    "mayo",
+    "uov",
+    "snova",
+    "lattice-based",
+    "code-based",
+    "hash-based"
+  ],
+  "author": {
+    "name": "Open Quantum Safe",
+    "url": "https://github.com/open-quantum-safe"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/open-quantum-safe/liboqs-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/open-quantum-safe/liboqs-js/issues"
+  },
+  "homepage": "https://open-quantum-safe.github.io/liboqs-js",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@vitest/browser": "^3.2.4",
+    "playwright": "^1.55.1",
+    "typedoc": "^0.28.13",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  }
+}

package/src/algorithms/kem/classic-mceliece/classic-mceliece-348864.js

@@ -0,0 +1,336 @@
+/**
+ * @fileoverview Classic-McEliece-348864 KEM algorithm implementation
+ * @module algorithms/kem/classic-mceliece/classic-mceliece-348864
+ * @description
+ * Classic-McEliece-348864 is a code-based key encapsulation mechanism providing NIST security level 1.
+ * It is based on the McEliece cryptosystem using binary Goppa codes.
+ *
+ * Key features:
+ * - Code-based cryptography (Goppa codes)
+ * - Security Level 1 (128-bit classical, quantum-resistant)
+ * - Extremely conservative security margin
+ * - IND-CCA2 security
+ * - Very large public keys, small ciphertexts
+ *
+ * @see {@link https://classic.mceliece.org/} - Classic McEliece specification
+ */
+
+import { LibOQSError, LibOQSInitError, LibOQSOperationError, LibOQSValidationError } from '../../../core/errors.js';
+import { isUint8Array } from '../../../core/validation.js';
+
+// Dynamic module loading for cross-runtime compatibility
+async function loadModule() {
+  const isDeno = typeof Deno !== 'undefined';
+  const modulePath = isDeno
+    ? '../../../../dist/classic-mceliece-348864.deno.js'
+    : '../../../../dist/classic-mceliece-348864.min.js';
+
+  const module = await import(modulePath);
+  return module.default;
+}
+
+/**
+ * CLASSIC-MCELIECE-348864-INFO algorithm constants and metadata
+ * @type {{readonly name: 'Classic-McEliece-348864', readonly identifier: 'Classic-McEliece-348864', readonly type: 'kem', readonly securityLevel: 1, readonly standardized: false, readonly description: string, readonly keySize: {readonly publicKey: 261120, readonly secretKey: 6492, readonly ciphertext: 96, readonly sharedSecret: 32}}}
+ */
+export const CLASSIC_MCELIECE_348864_INFO = {
+  name: 'Classic-McEliece-348864',
+  identifier: 'Classic-McEliece-348864',
+  type: 'kem',
+  securityLevel: 1,
+  standardized: false,
+  description: 'Classic McEliece 348864 code-based KEM (NIST Level 1, 128-bit quantum security)',
+  keySize: {
+    publicKey: 261120,
+    secretKey: 6492,
+    ciphertext: 96,
+    sharedSecret: 32
+  }
+};
+
+/**
+ * Load and initialize Classic-McEliece-348864 module
+ * @returns {Promise<ClassicMcEliece348864>} Initialized Classic-McEliece-348864 instance
+ * @throws {LibOQSInitError} If initialization fails
+ * @example
+ * import { createClassicMcEliece348864 } from '@oqs/liboqs-js';
+ * const kem = await createClassicMcEliece348864();
+ */
+export async function createClassicMcEliece348864() {
+  const moduleFactory = await loadModule();
+  const wasmModule = await moduleFactory();
+  wasmModule._OQS_init();
+
+  const algoName = CLASSIC_MCELIECE_348864_INFO.identifier;
+  const nameLen = wasmModule.lengthBytesUTF8(algoName);
+  const namePtr = wasmModule._malloc(nameLen + 1);
+  wasmModule.stringToUTF8(algoName, namePtr, nameLen + 1);
+
+  const kemPtr = wasmModule._OQS_KEM_new(namePtr);
+  wasmModule._free(namePtr);
+
+  if (!kemPtr) {
+    throw new LibOQSInitError('Classic-McEliece-348864', 'Failed to create KEM instance');
+  }
+
+  return new ClassicMcEliece348864(wasmModule, kemPtr);
+}
+
+/**
+ * Classic-McEliece-348864 wrapper class providing high-level KEM operations
+ *
+ * This class wraps the low-level WASM module to provide a user-friendly
+ * interface for Classic-McEliece-348864 operations with automatic memory management
+ * and input validation.
+ *
+ * @class ClassicMcEliece348864
+ * @example
+ * import { createClassicMcEliece348864 } from '@oqs/liboqs-js';
+ *
+ * const kem = await createClassicMcEliece348864();
+ * const { publicKey, secretKey } = kem.generateKeyPair();
+ * const { ciphertext, sharedSecret } = kem.encapsulate(publicKey);
+ * kem.destroy();
+ */
+export class ClassicMcEliece348864 {
+  /** @type {Object} @private */
+  #wasmModule;
+  /** @type {number} @private */
+  #kemPtr;
+  /** @type {boolean} @private */
+  #destroyed = false;
+
+  /**
+   * @param {Object} wasmModule - Emscripten WASM module
+   * @param {number} kemPtr - Pointer to KEM instance
+   * @private
+   */
+  constructor(wasmModule, kemPtr) {
+    this.#wasmModule = wasmModule;
+    this.#kemPtr = kemPtr;
+  }
+
+  /**
+   * Generate a new keypair for Classic-McEliece-348864
+   *
+   * Generates a public/private keypair using the algorithm's internal
+   * random number generator. The secret key must be kept confidential.
+   *
+   * @returns {publicKey: Uint8Array, secretKey: Uint8Array} Generated keypair
+   * @throws {LibOQSOperationError} If keypair generation fails
+   * @throws {LibOQSError} If instance has been destroyed
+   * @example
+   * const { publicKey, secretKey } = kem.generateKeyPair();
+   * // publicKey: 261120 bytes
+   * // secretKey: 6492 bytes (keep confidential!)
+   */
+  generateKeyPair() {
+    this.#checkDestroyed();
+
+    const publicKeyPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.publicKey);
+    const secretKeyPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.secretKey);
+
+    try {
+      const result = this.#wasmModule._OQS_KEM_keypair(this.#kemPtr, publicKeyPtr, secretKeyPtr);
+
+      if (result !== 0) {
+        throw new LibOQSOperationError('keypair', 'Classic-McEliece-348864', `Error code: ${result}`);
+      }
+
+      const publicKey = new Uint8Array(CLASSIC_MCELIECE_348864_INFO.keySize.publicKey);
+      const secretKey = new Uint8Array(CLASSIC_MCELIECE_348864_INFO.keySize.secretKey);
+
+      publicKey.set(this.#wasmModule.HEAPU8.subarray(publicKeyPtr, publicKeyPtr + CLASSIC_MCELIECE_348864_INFO.keySize.publicKey));
+      secretKey.set(this.#wasmModule.HEAPU8.subarray(secretKeyPtr, secretKeyPtr + CLASSIC_MCELIECE_348864_INFO.keySize.secretKey));
+
+      return { publicKey, secretKey };
+
+    } finally {
+      this.#wasmModule._free(publicKeyPtr);
+      this.#wasmModule._free(secretKeyPtr);
+    }
+  }
+
+  /**
+   * Encapsulate a shared secret using a public key
+   *
+   * Generates a random shared secret and encapsulates it using the
+   * provided public key. The shared secret can be used for symmetric
+   * encryption.
+   *
+   * @param {Uint8Array} publicKey - Recipient's public key (261120 bytes)
+   * @returns {ciphertext: Uint8Array, sharedSecret: Uint8Array} Encapsulation result
+   * @throws {LibOQSValidationError} If public key is invalid
+   * @throws {LibOQSOperationError} If encapsulation fails
+   * @throws {LibOQSError} If instance has been destroyed
+   * @example
+   * const { ciphertext, sharedSecret } = kem.encapsulate(recipientPublicKey);
+   * // ciphertext: 96 bytes (send to recipient)
+   * // sharedSecret: 32 bytes (use for symmetric encryption)
+   */
+  encapsulate(publicKey) {
+    this.#checkDestroyed();
+    this.#validatePublicKey(publicKey);
+
+    const publicKeyPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.publicKey);
+    const ciphertextPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.ciphertext);
+    const sharedSecretPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.sharedSecret);
+
+    try {
+      this.#wasmModule.HEAPU8.set(publicKey, publicKeyPtr);
+
+      const result = this.#wasmModule._OQS_KEM_encaps(
+        this.#kemPtr,
+        ciphertextPtr,
+        sharedSecretPtr,
+        publicKeyPtr
+      );
+
+      if (result !== 0) {
+        throw new LibOQSOperationError('encaps', 'Classic-McEliece-348864', `Error code: ${result}`);
+      }
+
+      const ciphertext = new Uint8Array(CLASSIC_MCELIECE_348864_INFO.keySize.ciphertext);
+      const sharedSecret = new Uint8Array(CLASSIC_MCELIECE_348864_INFO.keySize.sharedSecret);
+
+      ciphertext.set(this.#wasmModule.HEAPU8.subarray(ciphertextPtr, ciphertextPtr + CLASSIC_MCELIECE_348864_INFO.keySize.ciphertext));
+      sharedSecret.set(this.#wasmModule.HEAPU8.subarray(sharedSecretPtr, sharedSecretPtr + CLASSIC_MCELIECE_348864_INFO.keySize.sharedSecret));
+
+      return { ciphertext, sharedSecret };
+
+    } finally {
+      this.#wasmModule._free(publicKeyPtr);
+      this.#wasmModule._free(ciphertextPtr);
+      this.#wasmModule._free(sharedSecretPtr);
+    }
+  }
+
+  /**
+   * Decapsulate a shared secret using a secret key
+   *
+   * Recovers the shared secret from a ciphertext using the secret key.
+   * The recovered shared secret will match the one generated during
+   * encapsulation.
+   *
+   * @param {Uint8Array} ciphertext - Ciphertext received (96 bytes)
+   * @param {Uint8Array} secretKey - Recipient's secret key (6492 bytes)
+   * @returns {Uint8Array} Recovered shared secret (32 bytes)
+   * @throws {LibOQSValidationError} If inputs are invalid
+   * @throws {LibOQSOperationError} If decapsulation fails
+   * @throws {LibOQSError} If instance has been destroyed
+   * @example
+   * const sharedSecret = kem.decapsulate(ciphertext, mySecretKey);
+   * // sharedSecret: 32 bytes (matches sender's shared secret)
+   */
+  decapsulate(ciphertext, secretKey) {
+    this.#checkDestroyed();
+    this.#validateCiphertext(ciphertext);
+    this.#validateSecretKey(secretKey);
+
+    const ciphertextPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.ciphertext);
+    const secretKeyPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.secretKey);
+    const sharedSecretPtr = this.#wasmModule._malloc(CLASSIC_MCELIECE_348864_INFO.keySize.sharedSecret);
+
+    try {
+      this.#wasmModule.HEAPU8.set(ciphertext, ciphertextPtr);
+      this.#wasmModule.HEAPU8.set(secretKey, secretKeyPtr);
+
+      const result = this.#wasmModule._OQS_KEM_decaps(
+        this.#kemPtr,
+        sharedSecretPtr,
+        ciphertextPtr,
+        secretKeyPtr
+      );
+
+      if (result !== 0) {
+        throw new LibOQSOperationError('decaps', 'Classic-McEliece-348864', `Error code: ${result}`);
+      }
+
+      const sharedSecret = new Uint8Array(CLASSIC_MCELIECE_348864_INFO.keySize.sharedSecret);
+      sharedSecret.set(this.#wasmModule.HEAPU8.subarray(sharedSecretPtr, sharedSecretPtr + CLASSIC_MCELIECE_348864_INFO.keySize.sharedSecret));
+
+      return sharedSecret;
+
+    } finally {
+      this.#wasmModule._free(ciphertextPtr);
+      this.#wasmModule._free(secretKeyPtr);
+      this.#wasmModule._free(sharedSecretPtr);
+    }
+  }
+
+  /**
+   * Clean up resources and free WASM memory
+   *
+   * This method should be called when you're done using the instance
+   * to free WASM memory. After calling destroy(), the instance cannot
+   * be used for further operations.
+   *
+   * @example
+   * const kem = await createClassicMcEliece348864();
+   * // ... use kem ...
+   * kem.destroy();
+   */
+  destroy() {
+    if (!this.#destroyed) {
+      if (this.#kemPtr) {
+        this.#wasmModule._OQS_KEM_free(this.#kemPtr);
+        this.#kemPtr = null;
+      }
+      this.#destroyed = true;
+    }
+  }
+
+  /**
+   * Enables automatic cleanup via `using` declarations
+   * @example
+   * using instance = await create...();
+   * // automatically cleaned up at end of scope
+   */
+  [Symbol.dispose]() {
+    this.destroy();
+  }
+
+  /**
+   * Get algorithm information and constants
+   * @returns {typeof CLASSIC_MCELIECE_348864_INFO} Algorithm metadata (copy of CLASSIC_MCELIECE_348864_INFO)
+   * @example
+   * const info = kem.info;
+   * console.log(info.keySize.publicKey); // 261120
+   */
+  get info() {
+    return CLASSIC_MCELIECE_348864_INFO;
+  }
+
+  #checkDestroyed() {
+    if (this.#destroyed) {
+      throw new LibOQSError('Instance has been destroyed', 'Classic-McEliece-348864');
+    }
+  }
+
+  #validatePublicKey(publicKey) {
+    if (!isUint8Array(publicKey) || publicKey.length !== CLASSIC_MCELIECE_348864_INFO.keySize.publicKey) {
+      throw new LibOQSValidationError(
+        `Invalid public key: expected ${CLASSIC_MCELIECE_348864_INFO.keySize.publicKey} bytes, got ${publicKey?.length ?? 'null'}`,
+        'Classic-McEliece-348864'
+      );
+    }
+  }
+
+  #validateSecretKey(secretKey) {
+    if (!isUint8Array(secretKey) || secretKey.length !== CLASSIC_MCELIECE_348864_INFO.keySize.secretKey) {
+      throw new LibOQSValidationError(
+        `Invalid secret key: expected ${CLASSIC_MCELIECE_348864_INFO.keySize.secretKey} bytes, got ${secretKey?.length ?? 'null'}`,
+        'Classic-McEliece-348864'
+      );
+    }
+  }
+
+  #validateCiphertext(ciphertext) {
+    if (!isUint8Array(ciphertext) || ciphertext.length !== CLASSIC_MCELIECE_348864_INFO.keySize.ciphertext) {
+      throw new LibOQSValidationError(
+        `Invalid ciphertext: expected ${CLASSIC_MCELIECE_348864_INFO.keySize.ciphertext} bytes, got ${ciphertext?.length ?? 'null'}`,
+        'Classic-McEliece-348864'
+      );
+    }
+  }
+}