MLKEMEngine (Javadocs [I2P+ 2.13.0+]

java.lang.Object
- org.bouncycastle.pqc.crypto.mlkem.MLKEMEngine

```
class MLKEMEngine
extends Object
```
Core engine for ML-KEM (Module-Lattice Key Encapsulation Mechanism) operations. Implements the cryptographic primitives for key generation, encapsulation, and decapsulation.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`KyberN` Kyber N parameter
`static int`	`KyberPolyBytes` Kyber polynomial bytes
`static int`	`KyberQ` Kyber Q parameter
`static int`	`KyberQinv` Kyber Q inverse parameter
`static int`	`KyberSymBytes` Number of bytes for Hashes and Seeds

Constructor Summary
Constructors
Constructor and Description
MLKEMEngine(int k)

Constructors
Constructor and Description
`MLKEMEngine(int k)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[][]`	`generateKemKeyPair()`
`byte[][]`	`generateKemKeyPairInternal(byte[] d, byte[] z)`
`int`	`getCryptoBytes()`
`int`	`getCryptoCipherTextBytes()`
`int`	`getCryptoPublicKeyBytes()`
`int`	`getCryptoSecretKeyBytes()`
`int`	`getKyberCipherTextBytes()`
`int`	`getKyberEta1()`
`static int`	`getKyberEta2()`
`int`	`getKyberIndCpaBytes()`
`static int`	`getKyberIndCpaMsgBytes()`
`int`	`getKyberIndCpaPublicKeyBytes()`
`int`	`getKyberIndCpaSecretKeyBytes()`
`int`	`getKyberK()`
`int`	`getKyberPolyCompressedBytes()`
`int`	`getKyberPolyVecBytes()`
`int`	`getKyberPolyVecCompressedBytes()`
`int`	`getKyberPublicKeyBytes()`
`int`	`getKyberSecretKeyBytes()`
`void`	`getRandomBytes(byte[] buf)`
`Symmetric`	`getSymmetric()`
`void`	`init(SecureRandom random)`
`byte[]`	`kemDecrypt(byte[] secretKey, byte[] cipherText)`
`byte[]`	`kemDecryptInternal(byte[] secretKey, byte[] cipherText)`
`byte[][]`	`kemEncrypt(byte[] publicKeyInput, byte[] randBytes)`
`byte[][]`	`kemEncryptInternal(byte[] publicKeyInput, byte[] randBytes)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - KyberN
```
public static final int KyberN
```
    Kyber N parameter
    See Also:
    Constant Field Values
  - KyberPolyBytes
```
public static final int KyberPolyBytes
```
    Kyber polynomial bytes
    See Also:
    Constant Field Values
  - KyberQ
```
public static final int KyberQ
```
    Kyber Q parameter
    See Also:
    Constant Field Values
  - KyberQinv
```
public static final int KyberQinv
```
    Kyber Q inverse parameter
    See Also:
    Constant Field Values
  - KyberSymBytes
```
public static final int KyberSymBytes
```
    Number of bytes for Hashes and Seeds
    See Also:
    Constant Field Values
- Constructor Detail
  - MLKEMEngine
```
public MLKEMEngine(int k)
```
    Parameters:
    k - the security parameter (2, 3, or 4)
- Method Detail
  - generateKemKeyPair
```
public byte[][] generateKemKeyPair()
```
    Returns:
    key pair as byte array
  - generateKemKeyPairInternal
```
public byte[][] generateKemKeyPairInternal(byte[] d,
                                           byte[] z)
```
    Parameters:
    d - seed
    z - seed
    Returns:
    key pair as byte array
  - getCryptoBytes
```
public int getCryptoBytes()
```
    Returns:
    CryptoBytes
  - getCryptoCipherTextBytes
```
public int getCryptoCipherTextBytes()
```
    Returns:
    CryptoCipherTextBytes
  - getCryptoPublicKeyBytes
```
public int getCryptoPublicKeyBytes()
```
    Returns:
    CryptoPublicKeyBytes
  - getCryptoSecretKeyBytes
```
public int getCryptoSecretKeyBytes()
```
    Returns:
    CryptoSecretKeyBytes
  - getKyberCipherTextBytes
```
public int getKyberCipherTextBytes()
```
    Returns:
    KyberCipherTextBytes
  - getKyberEta1
```
public int getKyberEta1()
```
    Returns:
    KyberEta1
  - getKyberEta2
```
public static int getKyberEta2()
```
    Returns:
    KyberEta2
  - getKyberIndCpaBytes
```
public int getKyberIndCpaBytes()
```
    Returns:
    KyberIndCpaBytes
  - getKyberIndCpaMsgBytes
```
public static int getKyberIndCpaMsgBytes()
```
    Returns:
    KyberIndCpaMsgBytes
  - getKyberIndCpaPublicKeyBytes
```
public int getKyberIndCpaPublicKeyBytes()
```
    Returns:
    KyberIndCpaPublicKeyBytes
  - getKyberIndCpaSecretKeyBytes
```
public int getKyberIndCpaSecretKeyBytes()
```
    Returns:
    KyberIndCpaSecretKeyBytes
  - getKyberK
```
public int getKyberK()
```
    Returns:
    KyberK
  - getKyberPolyCompressedBytes
```
public int getKyberPolyCompressedBytes()
```
    Returns:
    KyberPolyCompressedBytes
  - getKyberPolyVecBytes
```
public int getKyberPolyVecBytes()
```
    Returns:
    KyberPolyVecBytes
  - getKyberPolyVecCompressedBytes
```
public int getKyberPolyVecCompressedBytes()
```
    Returns:
    KyberPolyVecCompressedBytes
  - getKyberPublicKeyBytes
```
public int getKyberPublicKeyBytes()
```
    Returns:
    KyberPublicKeyBytes
  - getKyberSecretKeyBytes
```
public int getKyberSecretKeyBytes()
```
    Returns:
    KyberSecretKeyBytes
  - getRandomBytes
```
public void getRandomBytes(byte[] buf)
```
    Parameters:
    buf - the buffer to fill
  - getSymmetric
```
public Symmetric getSymmetric()
```
    Returns:
    the symmetric
  - init
```
public void init(SecureRandom random)
```
    Parameters:
    random - the secure random
  - kemDecrypt
```
public byte[] kemDecrypt(byte[] secretKey,
                         byte[] cipherText)
```
    Parameters:
    secretKey - the secret key
    cipherText - the ciphertext
    Returns:
    shared secret
  - kemDecryptInternal
```
public byte[] kemDecryptInternal(byte[] secretKey,
                                 byte[] cipherText)
```
    Parameters:
    secretKey - the secret key
    cipherText - the ciphertext
    Returns:
    shared secret
  - kemEncrypt
```
public byte[][] kemEncrypt(byte[] publicKeyInput,
                           byte[] randBytes)
```
    Parameters:
    publicKeyInput - the public key
    randBytes - random bytes
    Returns:
    ciphertext and shared secret
  - kemEncryptInternal
```
public byte[][] kemEncryptInternal(byte[] publicKeyInput,
                                   byte[] randBytes)
```
    Parameters:
    publicKeyInput - the public key
    randBytes - random bytes
    Returns:
    ciphertext and shared secret

Class MLKEMEngine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

KyberN

KyberPolyBytes

KyberQ

KyberQinv

KyberSymBytes

Constructor Detail

MLKEMEngine

Method Detail

generateKemKeyPair

generateKemKeyPairInternal

getCryptoBytes

getCryptoCipherTextBytes

getCryptoPublicKeyBytes

getCryptoSecretKeyBytes

getKyberCipherTextBytes

getKyberEta1

getKyberEta2

getKyberIndCpaBytes

getKyberIndCpaMsgBytes

getKyberIndCpaPublicKeyBytes

getKyberIndCpaSecretKeyBytes

getKyberK

getKyberPolyCompressedBytes

getKyberPolyVecBytes

getKyberPolyVecCompressedBytes

getKyberPublicKeyBytes

getKyberSecretKeyBytes

getRandomBytes

getSymmetric

init

kemDecrypt

kemDecryptInternal

kemEncrypt

kemEncryptInternal