Package org.bouncycastle.pqc.jcajce.provider.lms

Class BCLMSPrivateKey

java.lang.Object

org.bouncycastle.pqc.jcajce.provider.lms.BCLMSPrivateKey

All Implemented Interfaces:

Serializable, Key, PrivateKey, Destroyable, LMSKey, LMSPrivateKey

public class BCLMSPrivateKey
extends Object
implements PrivateKey, LMSPrivateKey

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
BCLMSPrivateKey(PrivateKeyInfo keyInfo)
BCLMSPrivateKey(LMSKeyParameters keyParams)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
LMSPrivateKey	extractKeyShard(int usageCount)	Return a key representing a shard of the key space that can be used usageCount times.
String	getAlgorithm()
byte[]	getEncoded()
String	getFormat()
long	getIndex()	Return the index of the next signature.
int	getLevels()	Return the number of levels (L) associated with the key.
long	getUsagesRemaining()	Return the number of usages left for the private key.
int	hashCode()

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Constructor Details

BCLMSPrivateKey

public BCLMSPrivateKey(LMSKeyParameters keyParams)

BCLMSPrivateKey

public BCLMSPrivateKey(PrivateKeyInfo keyInfo)
                throws IOException

Throws:

IOException

Method Details

getIndex

public long getIndex()

Description copied from interface: LMSPrivateKey

Return the index of the next signature.

Specified by:

getIndex in interface LMSPrivateKey

Returns:

the index number for the next signature.

getUsagesRemaining

public long getUsagesRemaining()

Description copied from interface: LMSPrivateKey

Return the number of usages left for the private key.

Specified by:

getUsagesRemaining in interface LMSPrivateKey

Returns:

the number of times the key can be used before it is exhausted.

extractKeyShard

public LMSPrivateKey extractKeyShard(int usageCount)

Description copied from interface: LMSPrivateKey

Return a key representing a shard of the key space that can be used usageCount times.

Note: this will use the range [index...index + usageCount) for the current key.

Specified by:

extractKeyShard in interface LMSPrivateKey

Parameters:

usageCount - the number of usages the key should have.

Returns:

a key based on the current key that can be used usageCount times.

getAlgorithm

public String getAlgorithm()

Specified by:

getAlgorithm in interface Key

getFormat

public String getFormat()

Specified by:

getFormat in interface Key

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface Key

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getLevels

public int getLevels()

Description copied from interface: LMSKey

Return the number of levels (L) associated with the key.

Specified by:

getLevels in interface LMSKey

Returns:

L.