Package org.bouncycastle.jcajce.provider.asymmetric.mldsa

Class BCMLDSAPrivateKey

java.lang.Object

org.bouncycastle.jcajce.provider.asymmetric.mldsa.BCMLDSAPrivateKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable, BCKey, MLDSAKey, MLDSAPrivateKey

public class BCMLDSAPrivateKey
extends java.lang.Object
implements MLDSAPrivateKey, javax.security.auth.Destroyable, BCKey

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
BCMLDSAPrivateKey(PrivateKeyInfo keyInfo)
BCMLDSAPrivateKey(MLDSAPrivateKeyParameters 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-DSA private key with another object.
java.lang.String	getAlgorithm()
byte[]	getEncoded()
java.lang.String	getFormat()
MLDSAParameterSpec	getParameterSpec()	Return the parameters for this key.
byte[]	getPrivateData()	Return the long form private data for the ML-DSA private key.
MLDSAPrivateKey	getPrivateKey(boolean preferSeedOnly)	Return a privateKey which will encode as seed-only or as an expanded-key.
MLDSAPublicKey	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

BCMLDSAPrivateKey

public BCMLDSAPrivateKey(MLDSAPrivateKeyParameters params)

BCMLDSAPrivateKey

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

Throws:

java.io.IOException

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this ML-DSA 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

getPrivateKey

public MLDSAPrivateKey getPrivateKey(boolean preferSeedOnly)

Description copied from interface: MLDSAPrivateKey

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

Specified by:

getPrivateKey in interface MLDSAPrivateKey

Parameters:

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

Returns:

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

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface java.security.Key

getPublicKey

public MLDSAPublicKey getPublicKey()

Description copied from interface: MLDSAPrivateKey

Return the public key corresponding to this private key.

Specified by:

getPublicKey in interface MLDSAPrivateKey

Returns:

a ML-DSA Public Key

getPrivateData

public byte[] getPrivateData()

Description copied from interface: MLDSAPrivateKey

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

Specified by:

getPrivateData in interface MLDSAPrivateKey

Returns:

long form private data for private key.

getSeed

public byte[] getSeed()

Description copied from interface: MLDSAPrivateKey

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

Specified by:

getSeed in interface MLDSAPrivateKey

Returns:

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

getParameterSpec

public MLDSAParameterSpec getParameterSpec()

Description copied from interface: MLDSAKey

Return the parameters for this key.

Specified by:

getParameterSpec in interface MLDSAKey

Returns:

a MLDSAParameterSpec

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