@openforge-sh/liboqs - v0.14.3
    Preparing search index...

    Class MAYO2

    MAYO-2 digital signature wrapper class

    MAYO2

    High-level wrapper for MAYO-2 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()
    const sig = await createMAYO2();

    // 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();
    Index

    Accessors

    info

    Methods

    generateKeyPair sign verify destroy

    Accessors

    • get info(): {
          name: "MAYO-2";
          identifier: "MAYO-2";
          type: "sig";
          securityLevel: 1;
          standardized: false;
          description: string;
          keySize: { publicKey: 4912; secretKey: 24; signature: 186 };
      }

      Get algorithm information

      Returns {
          name: "MAYO-2";
          identifier: "MAYO-2";
          type: "sig";
          securityLevel: 1;
          standardized: false;
          description: string;
          keySize: { publicKey: 4912; secretKey: 24; signature: 186 };
      }

      Algorithm metadata

      console.log(sig.info.name);           // 'MAYO-2'
      console.log(sig.info.securityLevel);  // 1
      console.log(sig.info.keySize);        // { publicKey: 4912, secretKey: 24, signature: 186 }

    Methods

    • Generate a new MAYO-2 keypair

      Returns { publicKey: Uint8Array; secretKey: Uint8Array }

      If instance is destroyed

      If key generation fails

      const { publicKey, secretKey } = sig.generateKeyPair();
      console.log('Public key:', publicKey.length);  // 4912 bytes
      console.log('Secret key:', secretKey.length);  // 24 bytes

    • Sign a message using the secret key

      Parameters

      • message: Uint8Array<ArrayBufferLike>

        Message to sign (arbitrary length)

      • secretKey: Uint8Array<ArrayBufferLike>

        Secret key for signing (24 bytes)

      Returns Uint8Array<ArrayBufferLike>

      Digital signature (up to 186 bytes)

      If instance is destroyed

      If inputs are invalid

      If signing fails

      const message = new TextEncoder().encode('Hello!');
      const signature = sig.sign(message, secretKey);
      console.log('Signature:', signature.length); // 186 bytes

    • Verify a signature against a message using the public key

      Parameters

      • message: Uint8Array<ArrayBufferLike>

        Original message that was signed

      • signature: Uint8Array<ArrayBufferLike>

        Signature to verify

      • publicKey: Uint8Array<ArrayBufferLike>

        Public key for verification (4912 bytes)

      Returns boolean

      True if signature is valid, false otherwise

      If instance is destroyed

      If inputs are invalid

      const isValid = sig.verify(message, signature, publicKey);
      if (isValid) {
        console.log('Signature is valid!');
      }

    • Free WASM resources

      Returns void

      Releases all WASM memory associated with this instance. The instance cannot be used after calling destroy().

      sig.destroy();
      // sig is now unusable

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods