Package org.bouncycastle.jcajce.provider.asymmetric.mlkem

Class BCMLKEMPrivateKey

java.lang.Object

org.bouncycastle.jcajce.provider.asymmetric.mlkem.BCMLKEMPrivateKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable, BCKey, MLKEMKey, MLKEMPrivateKey

public class BCMLKEMPrivateKey
extends java.lang.Object
implements MLKEMPrivateKey, javax.security.auth.Destroyable, BCKey

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BCMLKEMPrivateKey(PrivateKeyInfo keyInfo)
BCMLKEMPrivateKey(MLKEMPrivateKeyParameters params)

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroy this key, zeroizing the secret key material it holds.
boolean	equals(java.lang.Object o)	Compare this ML-KEM private key with another object.
java.lang.String	getAlgorithm()
byte[]	getEncoded()
java.lang.String	getFormat()
MLKEMParameterSpec	getParameterSpec()	Return the parameters for this key.
byte[]	getPrivateData()	Return the long form private data for the ML-KEM private key.
MLKEMPrivateKey	getPrivateKey(boolean preferSeedOnly)	Return a privateKey which will encode as seed-only or as an expanded-key.
MLKEMPublicKey	getPublicKey()	Return the public key corresponding to this private key.
byte[]	getSeed()	Return the seed the private key was generated from (if available).
int	hashCode()
boolean	isDestroyed()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BCMLKEMPrivateKey

public BCMLKEMPrivateKey(MLKEMPrivateKeyParameters params)

BCMLKEMPrivateKey

public BCMLKEMPrivateKey(PrivateKeyInfo keyInfo)
                  throws java.io.IOException

Throws:

java.io.IOException

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this ML-KEM private key with another object.

Overrides:

equals in class java.lang.Object

Parameters:

o - the other object

Returns:

the result of the comparison

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAlgorithm

public final java.lang.String getAlgorithm()

Specified by:

getAlgorithm in interface java.security.Key

Returns:

name of the algorithm - "ML-KEM"

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface java.security.Key

getPublicKey

public MLKEMPublicKey getPublicKey()

Description copied from interface: MLKEMPrivateKey

Return the public key corresponding to this private key.

Specified by:

getPublicKey in interface MLKEMPrivateKey

Returns:

a ML-KEM Public Key

getPrivateData

public byte[] getPrivateData()

Description copied from interface: MLKEMPrivateKey

Return the long form private data for the ML-KEM private key.

Specified by:

getPrivateData in interface MLKEMPrivateKey

Returns:

long form private data for private key.

getSeed

public byte[] getSeed()

Description copied from interface: MLKEMPrivateKey

Return the seed the private key was generated from (if available).

Specified by:

getSeed in interface MLKEMPrivateKey

Returns:

the seed for the private key, null if not available.

getPrivateKey

public MLKEMPrivateKey getPrivateKey(boolean preferSeedOnly)

Description copied from interface: MLKEMPrivateKey

Return a privateKey which will encode as seed-only or as an expanded-key.

Specified by:

getPrivateKey in interface MLKEMPrivateKey

Parameters:

preferSeedOnly - if true, return a privateKey which will encode to seed-only if possible.

Returns:

a new MLKEMPrivateKey which encodes to either seed-only or expanded-key.

getParameterSpec

public MLKEMParameterSpec getParameterSpec()

Description copied from interface: MLKEMKey

Return the parameters for this key.

Specified by:

getParameterSpec in interface MLKEMKey

Returns:

a MLKEMParameterSpec

getFormat

public java.lang.String getFormat()

Specified by:

getFormat in interface java.security.Key

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

destroy

public void destroy()

Destroy this key, zeroizing the secret key material it holds.

After destruction isDestroyed() returns true and the secret-bearing accessors (such as getEncoded(), getPrivateData() and getSeed()) throw IllegalStateException. As the underlying parameter arrays may be shared with keys derived from this one, destruction invalidates those references too.

Specified by:

destroy in interface javax.security.auth.Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface javax.security.auth.Destroyable