diff --git a/docs/main/classes/MlKem1024.html b/docs/main/classes/MlKem1024.html index 95c5107..0706bfd 100644 --- a/docs/main/classes/MlKem1024.html +++ b/docs/main/classes/MlKem1024.html @@ -4,7 +4,7 @@

Example

// Using jsr:
import { MlKem1024 } from "@dajiaji/mlkem";
// Using npm:
// import { MlKem1024 } from "mlkem"; // or "crystals-kyber-js"

const recipient = new MlKem1024();
const [pkR, skR] = await recipient.generateKeyPair();

const sender = new MlKem1024();
const [ct, ssS] = await sender.encap(pkR);

const ssR = await recipient.decap(ct, skR);
// ssS === ssR
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_compressedUSize _compressedVSize _du @@ -25,35 +25,35 @@ encap generateKeyPair

Constructors

constructor

Properties

Protected_compressedUSize

_compressedUSize: number = 0

Protected_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 11

_dv

_dv: number = 5

_eta1

_eta1: number = 2

_eta2

_eta2: number = 2

_k

_k: number = 4

Protected_pkSize

_pkSize: number = 0

Protected_skSize

_skSize: number = 0

Methods

Protected_compressU

  • _compressU(r: Uint8Array, u: number[][]): Uint8Array

  • Lossily compresses and serializes a vector of polynomials.

    +

    Returns MlKem1024

Properties

Protected_compressedUSize

_compressedUSize: number = 0

Protected_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 11

_dv

_dv: number = 5

_eta1

_eta1: number = 2

_eta2

_eta2: number = 2

_k

_k: number = 4

Protected_pkSize

_pkSize: number = 0

Protected_skSize

_skSize: number = 0

Methods

Protected_compressU

  • _compressU(r: Uint8Array, u: number[][]): Uint8Array

  • Lossily compresses and serializes a vector of polynomials.

    Parameters

    • r: Uint8Array
    • u: number[][]

      The vector of polynomials to compress.

    Returns Uint8Array

    The compressed and serialized data as a Uint8Array.

    -

Protected_compressV

  • _compressV(r: Uint8Array, v: number[]): Uint8Array

  • Lossily compresses and serializes a polynomial.

    +

Protected_compressV

  • _compressV(r: Uint8Array, v: number[]): Uint8Array

  • Lossily compresses and serializes a polynomial.

    Parameters

    • r: Uint8Array

      The output buffer to store the compressed data.

    • v: number[]

      The polynomial to compress.

    Returns Uint8Array

    The compressed and serialized data as a Uint8Array.

    -

Protected_decompressU

  • _decompressU(a: Uint8Array): number[][]

  • Deserializes and decompresses a vector of polynomials. +

Protected_decompressU

  • _decompressU(a: Uint8Array): number[][]

  • Deserializes and decompresses a vector of polynomials. This is the approximate inverse of the _compressU method. Since compression is lossy, the decompressed data may not match the original vector of polynomials.

    Parameters

    • a: Uint8Array

      The compressed and serialized data as a Uint8Array.

    Returns number[][]

    The decompressed vector of polynomials.

    -

Protected_decompressV

  • _decompressV(a: Uint8Array): number[]

  • Decompresses a given polynomial, representing the approximate inverse of +

Protected_decompressV

  • _decompressV(a: Uint8Array): number[]

  • Decompresses a given polynomial, representing the approximate inverse of compress2, in Uint8Array into an array of numbers.

    Note that compression is lossy, and thus decompression will not match the original input.

    Parameters

    • a: Uint8Array

      The Uint8Array to decompress.

    Returns number[]

    An array of numbers obtained from the decompression process.

    -

Protected_sampleNoise1

  • _sampleNoise1(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2D array of noise samples.

    +

Protected_sampleNoise1

  • _sampleNoise1(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2D array of noise samples.

    Parameters

    • sigma: Uint8Array

      The noise parameter.

    • offset: number

      The offset value.

    • size: number

      The size of the array.

    Returns number[][]

    The generated 2D array of noise samples.

    -

Protected_sampleNoise2

  • _sampleNoise2(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2-dimensional array of noise samples.

    +

Protected_sampleNoise2

  • _sampleNoise2(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2-dimensional array of noise samples.

    Parameters

    • sigma: Uint8Array

      The noise parameter.

    • offset: number

      The offset value.

    • size: number

      The size of the array.

    Returns number[][]

    The generated 2-dimensional array of noise samples.

    -

decap

  • decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array>

  • Generates a ciphertext for the public key and a shared secret.

    +

decap

  • decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array>

  • Generates a ciphertext for the public key and a shared secret.

    If an error occurred, throws MlKemError.

    Parameters

    • ct: Uint8Array

      A ciphertext generated by encap.

    • sk: Uint8Array

      A private key.

      @@ -62,7 +62,7 @@

      Example: The {@link MlKem768} decapsulation.

      // Using jsr:
      import { MlKem768 } from "@dajiaji/mlkem";
      // Using npm:
      // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

      const kyber = new MlKem768();
      const [pk, sk] = await kyber.generateKeyPair();
      const [ct, ssS] = await kyber.encap(pk);
      const ssR = await kyber.decap(ct, sk);
      // ssS === ssR
      -

deriveKeyPair

  • deriveKeyPair(seed: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

    +

deriveKeyPair

  • deriveKeyPair(seed: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

    If an error occurred, throws MlKemError.

    Parameters

    • seed: Uint8Array

      A 64-octet seed for the deterministic key generation.

    Returns Promise<[Uint8Array, Uint8Array]>

    A kaypair [publicKey, privateKey].

    @@ -70,7 +70,7 @@

    Example: Derives a {@link MlKem768} keypair deterministically.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const seed = new Uint8Array(64);
    globalThis.crypto.getRandomValues(seed);
    const [pk, sk] = await kyber.deriveKeyPair(seed);
    -

encap

  • encap(pk: Uint8Array, seed?: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Generates a shared secret from the encapsulated ciphertext and the private key.

    +

encap

  • encap(pk: Uint8Array, seed?: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Generates a shared secret from the encapsulated ciphertext and the private key.

    If an error occurred, throws MlKemError.

    Parameters

    • pk: Uint8Array

      A public key.

    • Optionalseed: Uint8Array

      An optional 32-octet seed for the deterministic shared secret generation.

      @@ -79,11 +79,11 @@

      Example: The {@link MlKem768} encapsulation.

      // Using jsr:
      import { MlKem768 } from "@dajiaji/mlkem";
      // Using npm:
      // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

      const kyber = new MlKem768();
      const [pk, sk] = await kyber.generateKeyPair();
      const [ct, ss] = await kyber.encap(pk);
      -

generateKeyPair

  • generateKeyPair(): Promise<[Uint8Array, Uint8Array]>

  • Generates a keypair [publicKey, privateKey].

    +

generateKeyPair

  • generateKeyPair(): Promise<[Uint8Array, Uint8Array]>

  • Generates a keypair [publicKey, privateKey].

    If an error occurred, throws MlKemError.

    Returns Promise<[Uint8Array, Uint8Array]>

    A kaypair [publicKey, privateKey].

    Throws

    MlKemError

    Example: Generates a {@link MlKem768} keypair.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const [pk, sk] = await kyber.generateKeyPair();
    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/main/classes/MlKem512.html b/docs/main/classes/MlKem512.html index 4083128..a6dd739 100644 --- a/docs/main/classes/MlKem512.html +++ b/docs/main/classes/MlKem512.html @@ -4,7 +4,7 @@

Example

// Using jsr:
import { MlKem512 } from "@dajiaji/mlkem";
// Using npm:
// import { MlKem512 } from "mlkem"; // or "crystals-kyber-js"

const recipient = new MlKem512();
const [pkR, skR] = await recipient.generateKeyPair();

const sender = new MlKem512();
const [ct, ssS] = await sender.encap(pkR);

const ssR = await recipient.decap(ct, skR);
// ssS === ssR
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_compressedUSize _compressedVSize _du @@ -25,31 +25,31 @@ encap generateKeyPair

Constructors

constructor

Properties

Protected_compressedUSize

_compressedUSize: number = 0

Protected_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 10

_dv

_dv: number = 4

_eta1

_eta1: number = 3

_eta2

_eta2: number = 2

_k

_k: number = 2

Protected_pkSize

_pkSize: number = 0

Protected_skSize

_skSize: number = 0

Methods

Protected_compressU

  • _compressU(r: Uint8Array, u: number[][]): Uint8Array

  • Compresses the given array of coefficients into a Uint8Array.

    +

    Returns MlKem512

Properties

Protected_compressedUSize

_compressedUSize: number = 0

Protected_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 10

_dv

_dv: number = 4

_eta1

_eta1: number = 3

_eta2

_eta2: number = 2

_k

_k: number = 2

Protected_pkSize

_pkSize: number = 0

Protected_skSize

_skSize: number = 0

Methods

Protected_compressU

  • _compressU(r: Uint8Array, u: number[][]): Uint8Array

  • Compresses the given array of coefficients into a Uint8Array.

    Parameters

    • r: Uint8Array

      The output Uint8Array.

    • u: number[][]

      The array of coefficients.

    Returns Uint8Array

    The compressed Uint8Array.

    -

Protected_compressV

  • _compressV(r: Uint8Array, v: number[]): Uint8Array

  • Compresses the given array of numbers into a Uint8Array.

    +

Protected_compressV

  • _compressV(r: Uint8Array, v: number[]): Uint8Array

  • Compresses the given array of numbers into a Uint8Array.

    Parameters

    • r: Uint8Array

      The Uint8Array to store the compressed values.

    • v: number[]

      The array of numbers to compress.

    Returns Uint8Array

    The compressed Uint8Array.

    -

Protected_decompressU

  • _decompressU(a: Uint8Array): number[][]

  • Decompresses a Uint8Array into a two-dimensional array of numbers.

    +

Protected_decompressU

  • _decompressU(a: Uint8Array): number[][]

  • Decompresses a Uint8Array into a two-dimensional array of numbers.

    Parameters

    • a: Uint8Array

      The Uint8Array to decompress.

    Returns number[][]

    The decompressed two-dimensional array.

    -

Protected_decompressV

  • _decompressV(a: Uint8Array): number[]

  • Decompresses a Uint8Array into an array of numbers.

    +

Protected_decompressV

  • _decompressV(a: Uint8Array): number[]

  • Decompresses a Uint8Array into an array of numbers.

    Parameters

    • a: Uint8Array

      The Uint8Array to decompress.

    Returns number[]

    An array of numbers.

    -

Protected_sampleNoise1

  • _sampleNoise1(sigma: Uint8Array, offset: number, size: number): number[][]
  • Internal

    Samples a vector of polynomials from a seed.

    +

Protected_sampleNoise1

  • _sampleNoise1(sigma: Uint8Array, offset: number, size: number): number[][]
  • Internal

    Samples a vector of polynomials from a seed.

    Parameters

    • sigma: Uint8Array

      The seed.

    • offset: number

      The offset.

    • size: number

      The size.

    Returns number[][]

    The sampled vector of polynomials.

    -

Protected_sampleNoise2

  • _sampleNoise2(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2-dimensional array of noise samples.

    +

Protected_sampleNoise2

  • _sampleNoise2(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2-dimensional array of noise samples.

    Parameters

    • sigma: Uint8Array

      The noise parameter.

    • offset: number

      The offset value.

    • size: number

      The size of the array.

    Returns number[][]

    The generated 2-dimensional array of noise samples.

    -

decap

  • decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array>

  • Generates a ciphertext for the public key and a shared secret.

    +

decap

  • decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array>

  • Generates a ciphertext for the public key and a shared secret.

    If an error occurred, throws MlKemError.

    Parameters

    • ct: Uint8Array

      A ciphertext generated by encap.

    • sk: Uint8Array

      A private key.

      @@ -58,7 +58,7 @@

      Example: The {@link MlKem768} decapsulation.

      // Using jsr:
      import { MlKem768 } from "@dajiaji/mlkem";
      // Using npm:
      // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

      const kyber = new MlKem768();
      const [pk, sk] = await kyber.generateKeyPair();
      const [ct, ssS] = await kyber.encap(pk);
      const ssR = await kyber.decap(ct, sk);
      // ssS === ssR
      -

deriveKeyPair

  • deriveKeyPair(seed: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

    +

deriveKeyPair

  • deriveKeyPair(seed: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

    If an error occurred, throws MlKemError.

    Parameters

    • seed: Uint8Array

      A 64-octet seed for the deterministic key generation.

    Returns Promise<[Uint8Array, Uint8Array]>

    A kaypair [publicKey, privateKey].

    @@ -66,7 +66,7 @@

    Example: Derives a {@link MlKem768} keypair deterministically.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const seed = new Uint8Array(64);
    globalThis.crypto.getRandomValues(seed);
    const [pk, sk] = await kyber.deriveKeyPair(seed);
    -

encap

  • encap(pk: Uint8Array, seed?: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Generates a shared secret from the encapsulated ciphertext and the private key.

    +

encap

  • encap(pk: Uint8Array, seed?: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Generates a shared secret from the encapsulated ciphertext and the private key.

    If an error occurred, throws MlKemError.

    Parameters

    • pk: Uint8Array

      A public key.

    • Optionalseed: Uint8Array

      An optional 32-octet seed for the deterministic shared secret generation.

      @@ -75,11 +75,11 @@

      Example: The {@link MlKem768} encapsulation.

      // Using jsr:
      import { MlKem768 } from "@dajiaji/mlkem";
      // Using npm:
      // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

      const kyber = new MlKem768();
      const [pk, sk] = await kyber.generateKeyPair();
      const [ct, ss] = await kyber.encap(pk);
      -

generateKeyPair

  • generateKeyPair(): Promise<[Uint8Array, Uint8Array]>

  • Generates a keypair [publicKey, privateKey].

    +

generateKeyPair

  • generateKeyPair(): Promise<[Uint8Array, Uint8Array]>

  • Generates a keypair [publicKey, privateKey].

    If an error occurred, throws MlKemError.

    Returns Promise<[Uint8Array, Uint8Array]>

    A kaypair [publicKey, privateKey].

    Throws

    MlKemError

    Example: Generates a {@link MlKem768} keypair.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const [pk, sk] = await kyber.generateKeyPair();
    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/main/classes/MlKem768.html b/docs/main/classes/MlKem768.html index af760a4..698bba7 100644 --- a/docs/main/classes/MlKem768.html +++ b/docs/main/classes/MlKem768.html @@ -4,7 +4,7 @@

Example

// Using jsr:
import { MlKem768 } from "@dajiaji/mlkem";
// Using npm:
// import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

const recipient = new MlKem768();
const [pkR, skR] = await recipient.generateKeyPair();

const sender = new MlKem768();
const [ct, ssS] = await sender.encap(pkR);

const ssR = await recipient.decap(ct, skR);
// ssS === ssR
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_compressedUSize _compressedVSize _du @@ -24,31 +24,31 @@ deriveKeyPair encap generateKeyPair -

Constructors

constructor

Properties

Protected_compressedUSize

_compressedUSize: number = 0

Protected_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 10

_dv

_dv: number = 4

_eta1

_eta1: number = 2

_eta2

_eta2: number = 2

_k

_k: number = 3

Protected_pkSize

_pkSize: number = 0

Protected_skSize

_skSize: number = 0

Methods

Protected_compressU

  • _compressU(r: Uint8Array, u: number[][]): Uint8Array

  • Compresses the given array of coefficients into a Uint8Array.

    +

Constructors

constructor

Properties

Protected_compressedUSize

_compressedUSize: number = 0

Protected_compressedVSize

_compressedVSize: number = 0

_du

_du: number = 10

_dv

_dv: number = 4

_eta1

_eta1: number = 2

_eta2

_eta2: number = 2

_k

_k: number = 3

Protected_pkSize

_pkSize: number = 0

Protected_skSize

_skSize: number = 0

Methods

Protected_compressU

  • _compressU(r: Uint8Array, u: number[][]): Uint8Array

  • Compresses the given array of coefficients into a Uint8Array.

    Parameters

    • r: Uint8Array

      The output Uint8Array.

    • u: number[][]

      The array of coefficients.

    Returns Uint8Array

    The compressed Uint8Array.

    -

Protected_compressV

  • _compressV(r: Uint8Array, v: number[]): Uint8Array

  • Compresses the given array of numbers into a Uint8Array.

    +

Protected_compressV

  • _compressV(r: Uint8Array, v: number[]): Uint8Array

  • Compresses the given array of numbers into a Uint8Array.

    Parameters

    • r: Uint8Array

      The Uint8Array to store the compressed values.

    • v: number[]

      The array of numbers to compress.

    Returns Uint8Array

    The compressed Uint8Array.

    -

Protected_decompressU

  • _decompressU(a: Uint8Array): number[][]

  • Decompresses a Uint8Array into a two-dimensional array of numbers.

    +

Protected_decompressU

  • _decompressU(a: Uint8Array): number[][]

  • Decompresses a Uint8Array into a two-dimensional array of numbers.

    Parameters

    • a: Uint8Array

      The Uint8Array to decompress.

    Returns number[][]

    The decompressed two-dimensional array.

    -

Protected_decompressV

  • _decompressV(a: Uint8Array): number[]

  • Decompresses a Uint8Array into an array of numbers.

    +

Protected_decompressV

  • _decompressV(a: Uint8Array): number[]

  • Decompresses a Uint8Array into an array of numbers.

    Parameters

    • a: Uint8Array

      The Uint8Array to decompress.

    Returns number[]

    An array of numbers.

    -

Protected_sampleNoise1

  • _sampleNoise1(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2D array of noise samples.

    +

Protected_sampleNoise1

  • _sampleNoise1(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2D array of noise samples.

    Parameters

    • sigma: Uint8Array

      The noise parameter.

    • offset: number

      The offset value.

    • size: number

      The size of the array.

    Returns number[][]

    The generated 2D array of noise samples.

    -

Protected_sampleNoise2

  • _sampleNoise2(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2-dimensional array of noise samples.

    +

Protected_sampleNoise2

  • _sampleNoise2(sigma: Uint8Array, offset: number, size: number): number[][]

  • Generates a 2-dimensional array of noise samples.

    Parameters

    • sigma: Uint8Array

      The noise parameter.

    • offset: number

      The offset value.

    • size: number

      The size of the array.

    Returns number[][]

    The generated 2-dimensional array of noise samples.

    -

decap

  • decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array>

  • Generates a ciphertext for the public key and a shared secret.

    +

decap

  • decap(ct: Uint8Array, sk: Uint8Array): Promise<Uint8Array>

  • Generates a ciphertext for the public key and a shared secret.

    If an error occurred, throws MlKemError.

    Parameters

    • ct: Uint8Array

      A ciphertext generated by encap.

    • sk: Uint8Array

      A private key.

      @@ -57,7 +57,7 @@

      Example: The {@link MlKem768} decapsulation.

      // Using jsr:
      import { MlKem768 } from "@dajiaji/mlkem";
      // Using npm:
      // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

      const kyber = new MlKem768();
      const [pk, sk] = await kyber.generateKeyPair();
      const [ct, ssS] = await kyber.encap(pk);
      const ssR = await kyber.decap(ct, sk);
      // ssS === ssR
      -

deriveKeyPair

  • deriveKeyPair(seed: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

    +

deriveKeyPair

  • deriveKeyPair(seed: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Derives a keypair [publicKey, privateKey] deterministically from a 64-octet seed.

    If an error occurred, throws MlKemError.

    Parameters

    • seed: Uint8Array

      A 64-octet seed for the deterministic key generation.

    Returns Promise<[Uint8Array, Uint8Array]>

    A kaypair [publicKey, privateKey].

    @@ -65,7 +65,7 @@

    Example: Derives a {@link MlKem768} keypair deterministically.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const seed = new Uint8Array(64);
    globalThis.crypto.getRandomValues(seed);
    const [pk, sk] = await kyber.deriveKeyPair(seed);
    -

encap

  • encap(pk: Uint8Array, seed?: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Generates a shared secret from the encapsulated ciphertext and the private key.

    +

encap

  • encap(pk: Uint8Array, seed?: Uint8Array): Promise<[Uint8Array, Uint8Array]>

  • Generates a shared secret from the encapsulated ciphertext and the private key.

    If an error occurred, throws MlKemError.

    Parameters

    • pk: Uint8Array

      A public key.

    • Optionalseed: Uint8Array

      An optional 32-octet seed for the deterministic shared secret generation.

      @@ -74,11 +74,11 @@

      Example: The {@link MlKem768} encapsulation.

      // Using jsr:
      import { MlKem768 } from "@dajiaji/mlkem";
      // Using npm:
      // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

      const kyber = new MlKem768();
      const [pk, sk] = await kyber.generateKeyPair();
      const [ct, ss] = await kyber.encap(pk);
      -

generateKeyPair

  • generateKeyPair(): Promise<[Uint8Array, Uint8Array]>

  • Generates a keypair [publicKey, privateKey].

    +

generateKeyPair

  • generateKeyPair(): Promise<[Uint8Array, Uint8Array]>

  • Generates a keypair [publicKey, privateKey].

    If an error occurred, throws MlKemError.

    Returns Promise<[Uint8Array, Uint8Array]>

    A kaypair [publicKey, privateKey].

    Throws

    MlKemError

    Example: Generates a {@link MlKem768} keypair.

    // Using jsr:
    import { MlKem768 } from "@dajiaji/mlkem";
    // Using npm:
    // import { MlKem768 } from "mlkem"; // or "crystals-kyber-js"

    const kyber = new MlKem768();
    const [pk, sk] = await kyber.generateKeyPair();
    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/main/classes/MlKemError.html b/docs/main/classes/MlKemError.html index 3a2d60d..dc4c1f9 100644 --- a/docs/main/classes/MlKemError.html +++ b/docs/main/classes/MlKemError.html @@ -1,7 +1,7 @@ MlKemError | API reference for crystals-kyber-js/main

Class MlKemError

The base error class of kyber-ts.

-

Hierarchy

  • Error
    • MlKemError

Constructors

constructor +

Hierarchy

  • Error
    • MlKemError

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties