iaik.security.pq.mlkem

Class MLKEMPrivateKey

java.lang.Object

iaik.pkcs.pkcs8.PrivateKeyInfo

iaik.security.pq.mlkem.MLKEMPrivateKey

All Implemented Interfaces:

iaik.asn1.ASN1Type, Serializable, Cloneable, Key, PrivateKey, Destroyable

public class MLKEMPrivateKey
extends iaik.pkcs.pkcs8.PrivateKeyInfo

This class holds a Kyber [0] Private Key. Is being updated according to FIPS 203 Draft [1]. [0] Roberto Avanzi, Joppe Bos, Léo Ducas, Eike Kiltz, Tancrède Lepoint, Vadim Lyubashevsky, John M. Schanck, Peter Schwabe, Gregor Seiler, and Damien Stehlé: "CRYSTALS-Kyber (version 3.02)" – Submission to round 3 of the NIST post-quantum project. [1] @see NIST.FIPS.203

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MLKEMPrivateKey.PrivateKeyEncoding This enumeration is only applied for the needed encoding as an ASN.1 object.

Field Summary

Fields inherited from class iaik.pkcs.pkcs8.PrivateKeyInfo

private_key_algorithm

Constructor Summary

Constructors

Constructor and Description
MLKEMPrivateKey(byte[] encoded) Create private key from an ASN.1 encoded byte sequence
MLKEMPrivateKey(byte[] byteDk, byte[] byteEk, byte[] byteHashedEk, byte[] z, MLKEMParameterSpec parameterSpec) Create private key from private key byte array, public key byte array, public key hash and seed z.
MLKEMPrivateKey(byte[] arr, MLKEMParameterSpec parameterSpec) Create private key from a byte array, where arr is either the seed, which is 64 bytes long, or the expandedKey, which is long as for the specific parameter defined.

Method Summary

Modifier and Type	Method and Description
protected void	decode(byte[] bytes)
protected byte[]	encode()
boolean	equals(Object o)
String	getAlgorithm()
byte[]	getExpandedKey() Returns a copy of the private key as a byte array (raw data).
MLKEMPrivateKey.PrivateKeyEncoding	getPrivateKeyEncodingDefault() Get the privateKeyEncodingDefault variable
MLKEMPublicKey	getPublicKey() Returns the MLKEMPublicKey
byte[]	getSeed() Returns a copy of the seed as a byte array.
int	hashCode()
void	setPrivateKeyEncodingDefault(MLKEMPrivateKey.PrivateKeyEncoding privateKeyEncoding) Set the privateKeyEncodingDefault variable
String	toString()

Methods inherited from class iaik.pkcs.pkcs8.PrivateKeyInfo

clone, createPrivateKeyInfo, decode, getAlgorithmID, getAttributes, getEncoded, getFormat, getPrivateKey, getPrivateKey, getPrivateKey, getPrivateKey, getPrivateKey, getPrivateKey, getPubKey, setAttributes, setPubKey, toASN1Object, writeTo

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Constructor Detail

MLKEMPrivateKey

public MLKEMPrivateKey(byte[] byteDk,
                       byte[] byteEk,
                       byte[] byteHashedEk,
                       byte[] z,
                       MLKEMParameterSpec parameterSpec)
                throws InvalidKeyException

Create private key from private key byte array, public key byte array, public key hash and seed z. The expandedKey is build internally by concatenating byteDk, byteEk, byteHashedEk and z. The seed cannot be recreated, therefore seed is null.

Parameters:

byteDk - private key (KEM decaps key) as a byte sequence

byteEk - public key (KEM encaps key) as a byte sequence

byteHashedEk - public key hash

z - seed

parameterSpec - the given specification of the parameters

Throws:

InvalidKeyException - throws an error if failing to create the encoding of the private key

MLKEMPrivateKey

public MLKEMPrivateKey(byte[] arr,
                       MLKEMParameterSpec parameterSpec)
                throws InvalidKeyException

Create private key from a byte array, where arr is either the seed, which is 64 bytes long, or the expandedKey, which is long as for the specific parameter defined. According to NIST FIPS203: For ML-KEM-512 expandedKey is 1632 bytes For ML-KEM-768 expandedKey is 2400 bytes For ML-KEM-1024 expandedKey is 3168 bytes

Parameters:

arr - raw byte array

parameterSpec - the given specification of the parameters

Throws:

InvalidKeyException - throws an error if failing to create the encoding of the private key

MLKEMPrivateKey

public MLKEMPrivateKey(byte[] encoded)
                throws InvalidKeyException

Create private key from an ASN.1 encoded byte sequence

Parameters:

encoded - private key encoded as ASN.1 byte sequence

Throws:

InvalidKeyException - if the encoding is not valid

Method Detail

setPrivateKeyEncodingDefault

public void setPrivateKeyEncodingDefault(MLKEMPrivateKey.PrivateKeyEncoding privateKeyEncoding)

Set the privateKeyEncodingDefault variable

Parameters:

privateKeyEncoding -

getPrivateKeyEncodingDefault

public MLKEMPrivateKey.PrivateKeyEncoding getPrivateKeyEncodingDefault()

Get the privateKeyEncodingDefault variable

Returns:

privateKeyEncoding

decode

protected void decode(byte[] bytes)
               throws InvalidKeyException

Specified by:

decode in class iaik.pkcs.pkcs8.PrivateKeyInfo

Throws:

InvalidKeyException

encode

protected byte[] encode()

Specified by:

encode in class iaik.pkcs.pkcs8.PrivateKeyInfo

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

Specified by:

getAlgorithm in class iaik.pkcs.pkcs8.PrivateKeyInfo

equals

public boolean equals(Object o)

Overrides:

equals in class iaik.pkcs.pkcs8.PrivateKeyInfo

hashCode

public int hashCode()

Overrides:

hashCode in class iaik.pkcs.pkcs8.PrivateKeyInfo

toString

public String toString()

Overrides:

toString in class iaik.pkcs.pkcs8.PrivateKeyInfo

getPublicKey

public MLKEMPublicKey getPublicKey()
                            throws InvalidKeyException

Returns the MLKEMPublicKey

Returns:

MLKEMPublicKey

Throws:

InvalidKeyException

getExpandedKey

public byte[] getExpandedKey()

Returns a copy of the private key as a byte array (raw data).

Returns:

the key as byte array expandedKey == (byteDk||byteEk||byteHashedEk||z)

getSeed

public byte[] getSeed()

Returns a copy of the seed as a byte array.

Returns:

the seed as byte array