@oqs/liboqs-js 0.15.0

package/src/algorithms/sig/mayo/mayo-5.js

@@ -0,0 +1,390 @@
+/**
+ * @fileoverview MAYO-5 signature algorithm implementation
+ * @module algorithms/sig/mayo/mayo-5
+ * @description
+ * MAYO-5 is a multivariate signature scheme based on the Oil and Vinegar problem.
+ * It provides compact signatures with NIST security level 5.
+ *
+ * Key features:
+ * - Multivariate cryptography (Oil and Vinegar)
+ * - Security Level 5 (256-bit classical, quantum-resistant)
+ * - Compact signatures (964 bytes)
+ * - Small secret keys (40 bytes)
+ *
+ * @see {@link https://pqmayo.org/} - MAYO 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/mayo-5.deno.js`
+    : `../../../../dist/mayo-5.min.js`;
+
+  const module = await import(modulePath);
+  return module.default;
+}
+
+/**
+ * MAYO-5-INFO algorithm constants and metadata
+ * @type {{readonly name: 'MAYO-5', readonly identifier: 'MAYO-5', readonly type: 'sig', readonly securityLevel: 5, readonly standardized: false, readonly description: string, readonly keySize: {readonly publicKey: 5554, readonly secretKey: 40, readonly signature: 964}}}
+ */
+export const MAYO_5_INFO = {
+  name: 'MAYO-5',
+  identifier: 'MAYO-5',
+  type: 'sig',
+  securityLevel: 5,
+  standardized: false,
+  description: 'MAYO-5 multivariate signature scheme (NIST Level 5, 256-bit quantum security)',
+  keySize: {
+    publicKey: 5554,
+    secretKey: 40,
+    signature: 964
+  }
+};
+
+/**
+ * Factory function to create a MAYO-5 signature instance
+ *
+ * @async
+ * @function createMAYO5
+ * @returns {Promise<MAYO5>} Initialized MAYO-5 instance
+ * @throws {LibOQSInitError} If module initialization fails
+ *
+ * @example
+ * import { createMAYO5 } from '@oqs/liboqs-js';
+ *
+ * const sig = await createMAYO5();
+ * const { publicKey, secretKey } = sig.generateKeyPair();
+ * sig.destroy();
+ */
+export async function createMAYO5() {
+  const moduleFactory = await loadModule();
+  const wasmModule = await moduleFactory();
+  wasmModule._OQS_init();
+
+  const algoName = MAYO_5_INFO.identifier;
+  const nameLen = wasmModule.lengthBytesUTF8(algoName);
+  const namePtr = wasmModule._malloc(nameLen + 1);
+  wasmModule.stringToUTF8(algoName, namePtr, nameLen + 1);
+
+  const sigPtr = wasmModule._OQS_SIG_new(namePtr);
+  wasmModule._free(namePtr);
+
+  if (!sigPtr) {
+    throw new LibOQSInitError('MAYO-5', 'Failed to create SIG instance');
+  }
+
+  return new MAYO5(wasmModule, sigPtr);
+}
+
+/**
+ * MAYO-5 digital signature wrapper class
+ *
+ * @class MAYO5
+ * @description
+ * High-level wrapper for MAYO-5 signature operations. Provides secure key generation,
+ * signing, and verification with automatic memory management.
+ *
+ * Memory Management:
+ * - All WASM memory is managed internally
+ * - Call destroy() when finished to free resources
+ * - Do not use instance after calling destroy()
+ *
+ * @example
+ * const sig = await createMAYO5();
+ *
+ * // Generate keypair
+ * const { publicKey, secretKey } = sig.generateKeyPair();
+ *
+ * // Sign message
+ * const message = new TextEncoder().encode('Hello, quantum world!');
+ * const signature = sig.sign(message, secretKey);
+ *
+ * // Verify signature
+ * const isValid = sig.verify(message, signature, publicKey);
+ *
+ * // Cleanup
+ * sig.destroy();
+ */
+export class MAYO5 {
+  /** @type {Object} @private */ #wasmModule;
+  /** @type {number} @private */ #sigPtr;
+  /** @type {boolean} @private */ #destroyed = false;
+
+  /**
+   * @private
+   * @constructor
+   * @param {Object} wasmModule - Emscripten WASM module
+   * @param {number} sigPtr - Pointer to OQS_SIG structure
+   */
+  constructor(wasmModule, sigPtr) {
+    this.#wasmModule = wasmModule;
+    this.#sigPtr = sigPtr;
+  }
+
+  /**
+   * Generate a new MAYO-5 keypair
+   *
+   * @async
+   * @returns {{publicKey: Uint8Array, secretKey: Uint8Array}}
+   * @throws {LibOQSError} If instance is destroyed
+   * @throws {LibOQSOperationError} If key generation fails
+   *
+   * @example
+   * const { publicKey, secretKey } = sig.generateKeyPair();
+   * console.log('Public key:', publicKey.length);  // 5554 bytes
+   * console.log('Secret key:', secretKey.length);  // 40 bytes
+   */
+  generateKeyPair() {
+    this.#checkDestroyed();
+
+    const publicKey = new Uint8Array(MAYO_5_INFO.keySize.publicKey);
+    const secretKey = new Uint8Array(MAYO_5_INFO.keySize.secretKey);
+
+    const publicKeyPtr = this.#wasmModule._malloc(publicKey.length);
+    const secretKeyPtr = this.#wasmModule._malloc(secretKey.length);
+
+    try {
+      const result = this.#wasmModule._OQS_SIG_keypair(this.#sigPtr, publicKeyPtr, secretKeyPtr);
+
+      if (result !== 0) {
+        throw new LibOQSOperationError('generateKeyPair', 'MAYO-5', 'Key generation failed');
+      }
+
+      publicKey.set(this.#wasmModule.HEAPU8.subarray(publicKeyPtr, publicKeyPtr + publicKey.length));
+      secretKey.set(this.#wasmModule.HEAPU8.subarray(secretKeyPtr, secretKeyPtr + secretKey.length));
+
+      return { publicKey, secretKey };
+    } finally {
+      this.#wasmModule._free(publicKeyPtr);
+      this.#wasmModule._free(secretKeyPtr);
+    }
+  }
+
+  /**
+   * Sign a message using the secret key
+   *
+   * @async
+   * @param {Uint8Array} message - Message to sign (arbitrary length)
+   * @param {Uint8Array} secretKey - Secret key for signing (40 bytes)
+   * @returns {Uint8Array} Digital signature (up to 964 bytes)
+   * @throws {LibOQSError} If instance is destroyed
+   * @throws {LibOQSValidationError} If inputs are invalid
+   * @throws {LibOQSOperationError} If signing fails
+   *
+   * @example
+   * const message = new TextEncoder().encode('Hello!');
+   * const signature = sig.sign(message, secretKey);
+   * console.log('Signature:', signature.length); // 964 bytes
+   */
+  sign(message, secretKey) {
+    this.#checkDestroyed();
+    this.#validateMessage(message);
+    this.#validateSecretKey(secretKey);
+
+    const signature = new Uint8Array(MAYO_5_INFO.keySize.signature);
+    const sigPtr = this.#wasmModule._malloc(signature.length);
+    const sigLenPtr = this.#wasmModule._malloc(8); // size_t
+    const msgPtr = this.#wasmModule._malloc(message.length);
+    const skPtr = this.#wasmModule._malloc(secretKey.length);
+
+    try {
+      this.#wasmModule.HEAPU8.set(message, msgPtr);
+      this.#wasmModule.HEAPU8.set(secretKey, skPtr);
+      this.#wasmModule.setValue(sigLenPtr, signature.length, 'i64');
+
+      const result = this.#wasmModule._OQS_SIG_sign(
+        this.#sigPtr,
+        sigPtr,
+        sigLenPtr,
+        msgPtr,
+        message.length,
+        skPtr
+      );
+
+      if (result !== 0) {
+        throw new LibOQSOperationError('sign', 'MAYO-5', 'Signing failed');
+      }
+
+      const actualSigLen = this.#wasmModule.getValue(sigLenPtr, 'i32');
+      const actualSignature = new Uint8Array(actualSigLen);
+      actualSignature.set(this.#wasmModule.HEAPU8.subarray(sigPtr, sigPtr + actualSigLen));
+
+      return actualSignature;
+    } finally {
+      this.#wasmModule._free(sigPtr);
+      this.#wasmModule._free(sigLenPtr);
+      this.#wasmModule._free(msgPtr);
+      this.#wasmModule._free(skPtr);
+    }
+  }
+
+  /**
+   * Verify a signature against a message using the public key
+   *
+   * @async
+   * @param {Uint8Array} message - Original message that was signed
+   * @param {Uint8Array} signature - Signature to verify
+   * @param {Uint8Array} publicKey - Public key for verification (5554 bytes)
+   * @returns {boolean} True if signature is valid, false otherwise
+   * @throws {LibOQSError} If instance is destroyed
+   * @throws {LibOQSValidationError} If inputs are invalid
+   *
+   * @example
+   * const isValid = sig.verify(message, signature, publicKey);
+   * if (isValid) {
+   *   console.log('Signature is valid!');
+   * }
+   */
+  verify(message, signature, publicKey) {
+    this.#checkDestroyed();
+    this.#validateMessage(message);
+    this.#validateSignature(signature);
+    this.#validatePublicKey(publicKey);
+
+    const msgPtr = this.#wasmModule._malloc(message.length);
+    const sigPtr = this.#wasmModule._malloc(signature.length);
+    const pkPtr = this.#wasmModule._malloc(publicKey.length);
+
+    try {
+      this.#wasmModule.HEAPU8.set(message, msgPtr);
+      this.#wasmModule.HEAPU8.set(signature, sigPtr);
+      this.#wasmModule.HEAPU8.set(publicKey, pkPtr);
+
+      const result = this.#wasmModule._OQS_SIG_verify(
+        this.#sigPtr,
+        msgPtr,
+        message.length,
+        sigPtr,
+        signature.length,
+        pkPtr
+      );
+
+      return result === 0;
+    } finally {
+      this.#wasmModule._free(msgPtr);
+      this.#wasmModule._free(sigPtr);
+      this.#wasmModule._free(pkPtr);
+    }
+  }
+
+  /**
+   * Free WASM resources
+   *
+   * @description
+   * Releases all WASM memory associated with this instance.
+   * The instance cannot be used after calling destroy().
+   *
+   * @example
+   * sig.destroy();
+   * // sig is now unusable
+   */
+  destroy() {
+    if (!this.#destroyed && this.#sigPtr) {
+      this.#wasmModule._OQS_SIG_free(this.#sigPtr);
+      this.#sigPtr = 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
+   *
+   * @readonly
+   * @returns {typeof MAYO_5_INFO} Algorithm metadata
+   *
+   * @example
+   * console.log(sig.info.name);           // 'MAYO-5'
+   * console.log(sig.info.securityLevel);  // 5
+   * console.log(sig.info.keySize);        // { publicKey: 5554, secretKey: 40, signature: 964 }
+   */
+  get info() {
+    return MAYO_5_INFO;
+  }
+
+  /**
+   * @private
+   * @throws {LibOQSError} If instance is destroyed
+   */
+  #checkDestroyed() {
+    if (this.#destroyed) {
+      throw new LibOQSError('Instance has been destroyed', 'MAYO-5');
+    }
+  }
+
+  /**
+   * @private
+   * @param {Uint8Array} message
+   * @throws {LibOQSValidationError} If message is invalid
+   */
+  #validateMessage(message) {
+    if (!ArrayBuffer.isView(message) || message.constructor.name !== 'Uint8Array') {
+      throw new LibOQSValidationError(
+        'Message must be Uint8Array',
+        'MAYO-5'
+      );
+    }
+  }
+
+  /**
+   * @private
+   * @param {Uint8Array} publicKey
+   * @throws {LibOQSValidationError} If public key size is invalid
+   */
+  #validatePublicKey(publicKey) {
+    if (!isUint8Array(publicKey) || publicKey.length !== MAYO_5_INFO.keySize.publicKey) {
+      throw new LibOQSValidationError(
+        `Invalid public key: expected ${MAYO_5_INFO.keySize.publicKey} bytes, got ${publicKey?.length ?? 'null'}`,
+        'MAYO-5'
+      );
+    }
+  }
+
+  /**
+   * @private
+   * @param {Uint8Array} secretKey
+   * @throws {LibOQSValidationError} If secret key size is invalid
+   */
+  #validateSecretKey(secretKey) {
+    if (!isUint8Array(secretKey) || secretKey.length !== MAYO_5_INFO.keySize.secretKey) {
+      throw new LibOQSValidationError(
+        `Invalid secret key: expected ${MAYO_5_INFO.keySize.secretKey} bytes, got ${secretKey?.length ?? 'null'}`,
+        'MAYO-5'
+      );
+    }
+  }
+
+  /**
+   * @private
+   * @param {Uint8Array} signature
+   * @throws {LibOQSValidationError} If signature is invalid
+   */
+  #validateSignature(signature) {
+    if (!isUint8Array(signature)) {
+      throw new LibOQSValidationError(
+        'Signature must be Uint8Array',
+        'MAYO-5'
+      );
+    }
+    if (signature.length === 0 || signature.length > MAYO_5_INFO.keySize.signature) {
+      throw new LibOQSValidationError(
+        `Invalid signature length: expected up to ${MAYO_5_INFO.keySize.signature} bytes, got ${signature.length}`,
+        'MAYO-5'
+      );
+    }
+  }
+}