Package org.bouncycastle.crypto.asymmetric

Class AsymmetricLMSPrivateKey

java.lang.Object

org.bouncycastle.crypto.asymmetric.AsymmetricLMSKey

org.bouncycastle.crypto.asymmetric.AsymmetricLMSPrivateKey

All Implemented Interfaces:

Destroyable, AsymmetricKey, AsymmetricPrivateKey, Key

public final class AsymmetricLMSPrivateKey
extends AsymmetricLMSKey
implements AsymmetricPrivateKey

Leighton-Micali Hash-Based Signatures (LMS) private keys.

Field Summary

Fields inherited from class org.bouncycastle.crypto.asymmetric.AsymmetricLMSKey

L

Constructor Summary

Constructors

Constructor	Description
AsymmetricLMSPrivateKey(byte[] encoding)	Construct a key from an encoding of a PrivateKeyInfo.
AsymmetricLMSPrivateKey(int levels, byte[] keyData, byte[] publicData)
AsymmetricLMSPrivateKey(PrivateKeyInfo keyInfo)	Construct a key from a PrivateKeyInfo.

Method Summary

Modifier and Type	Method	Description
void	destroy()
boolean	equals(Object o)	Return true if o is an equivalent key to this.
AsymmetricLMSPrivateKey	extractKeyShard(int usageCount)
org.bouncycastle.crypto.internal.pqc.lms.LMSContextBasedSigner	getContextBasedSigner()
byte[]	getEncoded()	Return an ASN.1 encoding of the key wrapped in a PrivateKeyInfo or a SubjectPublicKeyInfo structure.
long	getIndex()
byte[]	getPublicData()
byte[]	getSecret()
long	getUsagesRemaining()
int	hashCode()	Return the hashCode for the key.
boolean	isDestroyed()

Methods inherited from class org.bouncycastle.crypto.asymmetric.AsymmetricLMSKey

checkApprovedOnlyModeStatus, getAlgorithm, getL, isThreadCorrectMode, zeroize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bouncycastle.crypto.Key

getAlgorithm

Constructor Details

AsymmetricLMSPrivateKey

public AsymmetricLMSPrivateKey(int levels,
 byte[] keyData,
 byte[] publicData)

AsymmetricLMSPrivateKey

public AsymmetricLMSPrivateKey(byte[] encoding)
                        throws IOException

Construct a key from an encoding of a PrivateKeyInfo.

Parameters:

encoding - the DER encoding of the key.

Throws:

IOException

AsymmetricLMSPrivateKey

public AsymmetricLMSPrivateKey(PrivateKeyInfo keyInfo)
                        throws IOException

Construct a key from a PrivateKeyInfo.

Parameters:

keyInfo - the PrivateKeyInfo containing the key.

Throws:

IOException

Method Details

getUsagesRemaining

public long getUsagesRemaining()

getIndex

public long getIndex()

getSecret

public byte[] getSecret()

getPublicData

public byte[] getPublicData()

extractKeyShard

public AsymmetricLMSPrivateKey extractKeyShard(int usageCount)

getEncoded

public byte[] getEncoded()

Description copied from interface: AsymmetricKey

Return an ASN.1 encoding of the key wrapped in a PrivateKeyInfo or a SubjectPublicKeyInfo structure.

Specified by:

getEncoded in interface AsymmetricKey

Returns:

an encoding of a PrivateKeyInfo or a SubjectPublicKeyInfo structure.

destroy

public void destroy()

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Destroyable

equals

public boolean equals(Object o)

Description copied from interface: Key

Return true if o is an equivalent key to this.

Specified by:

equals in interface Key

Overrides:

equals in class Object

Parameters:

o - object to compare to.

Returns:

true if o is the same or equivalent key, false otherwise.

hashCode

public int hashCode()

Description copied from interface: Key

Return the hashCode for the key.

Specified by:

hashCode in interface Key

Overrides:

hashCode in class Object

Returns:

the key's hashCode.

getContextBasedSigner

public org.bouncycastle.crypto.internal.pqc.lms.LMSContextBasedSigner getContextBasedSigner()