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

    Class HQC256

    HQC-256 key encapsulation mechanism wrapper class

    HQC256

    High-level wrapper for HQC-256 KEM operations. Provides secure key generation, encapsulation, and decapsulation 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 kem = await createHQC256();

    // Generate keypair
    const { publicKey, secretKey } = kem.generateKeyPair();

    // Encapsulate
    const { ciphertext, sharedSecret } = kem.encapsulate(publicKey);

    // Decapsulate
    const recoveredSecret = kem.decapsulate(ciphertext, secretKey);

    // Cleanup
    kem.destroy();
    Index

    Accessors

    • get info(): {
          name: "HQC-256";
          identifier: "HQC-256";
          type: "kem";
          securityLevel: 5;
          standardized: false;
          description: string;
          keySize: {
              publicKey: 7245;
              secretKey: 7317;
              ciphertext: 14421;
              sharedSecret: 64;
          };
      }

      Get algorithm information

      Returns {
          name: "HQC-256";
          identifier: "HQC-256";
          type: "kem";
          securityLevel: 5;
          standardized: false;
          description: string;
          keySize: {
              publicKey: 7245;
              secretKey: 7317;
              ciphertext: 14421;
              sharedSecret: 64;
          };
      }

      Algorithm metadata

      console.log(kem.info.name);           // 'HQC-256'
      console.log(kem.info.securityLevel); // 5
      console.log(kem.info.keySize); // { publicKey: 7245, secretKey: 7317, ciphertext: 14421, sharedSecret: 64 }

    Methods

    • Generate a new HQC-256 keypair

      Returns { publicKey: Uint8Array; secretKey: Uint8Array }

      If instance is destroyed

      If key generation fails

      const { publicKey, secretKey } = kem.generateKeyPair();
      console.log('Public key:', publicKey.length); // 7245 bytes
      console.log('Secret key:', secretKey.length); // 7317 bytes
    • Encapsulate a shared secret using a public key

      Parameters

      • publicKey: Uint8Array<ArrayBufferLike>

        Public key (7245 bytes)

      Returns { ciphertext: Uint8Array; sharedSecret: Uint8Array }

      If instance is destroyed

      If public key size is invalid

      If encapsulation fails

      const { ciphertext, sharedSecret } = kem.encapsulate(publicKey);
      console.log('Ciphertext:', ciphertext.length); // 14421 bytes
      console.log('Shared secret:', sharedSecret.length); // 64 bytes
    • Decapsulate a shared secret using a secret key

      Parameters

      • ciphertext: Uint8Array<ArrayBufferLike>

        Ciphertext (14421 bytes)

      • secretKey: Uint8Array<ArrayBufferLike>

        Secret key (7317 bytes)

      Returns Uint8Array<ArrayBufferLike>

      Shared secret (64 bytes)

      If instance is destroyed

      If ciphertext or secret key size is invalid

      If decapsulation fails

      const sharedSecret = kem.decapsulate(ciphertext, secretKey);
      console.log('Recovered secret:', sharedSecret.length); // 64 bytes
    • Free WASM resources

      Returns void

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

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