org.bouncycastle.pqc.jcajce.provider.xmss

Class BCXMSSMTPrivateKey

java.lang.Object

org.bouncycastle.pqc.jcajce.provider.xmss.BCXMSSMTPrivateKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable, XMSSMTKey, XMSSMTPrivateKey

public class BCXMSSMTPrivateKey
extends java.lang.Object
implements java.security.PrivateKey, XMSSMTPrivateKey

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BCXMSSMTPrivateKey(ASN1ObjectIdentifier treeDigest, XMSSMTPrivateKeyParameters keyParams)
BCXMSSMTPrivateKey(PrivateKeyInfo keyInfo)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
XMSSMTPrivateKey	extractKeyShard(int usageCount) Return a key representing a shard of the key space that can be used usageCount times.
java.lang.String	getAlgorithm()
byte[]	getEncoded()
java.lang.String	getFormat()
int	getHeight()
long	getIndex() Return the index of the next signature.
int	getLayers()
java.lang.String	getTreeDigest()
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 Detail

BCXMSSMTPrivateKey

public BCXMSSMTPrivateKey(ASN1ObjectIdentifier treeDigest,
                          XMSSMTPrivateKeyParameters keyParams)

BCXMSSMTPrivateKey

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

Throws:

java.io.IOException

Method Detail

getIndex

public long getIndex()

Description copied from interface: XMSSMTPrivateKey

Return the index of the next signature.

Specified by:

getIndex in interface XMSSMTPrivateKey

Returns:

the index number for the next signature.

getUsagesRemaining

public long getUsagesRemaining()

Description copied from interface: XMSSMTPrivateKey

Return the number of usages left for the private key.

Specified by:

getUsagesRemaining in interface XMSSMTPrivateKey

Returns:

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

extractKeyShard

public XMSSMTPrivateKey extractKeyShard(int usageCount)

Description copied from interface: XMSSMTPrivateKey

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 XMSSMTPrivateKey

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 java.lang.String getAlgorithm()

Specified by:

getAlgorithm in interface java.security.Key

getFormat

public java.lang.String getFormat()

Specified by:

getFormat in interface java.security.Key

getEncoded

public byte[] getEncoded()

Specified by:

getEncoded in interface java.security.Key

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getHeight

public int getHeight()

Specified by:

getHeight in interface XMSSMTKey

getLayers

public int getLayers()

Specified by:

getLayers in interface XMSSMTKey

getTreeDigest

public java.lang.String getTreeDigest()

Specified by:

getTreeDigest in interface XMSSMTKey