Top Description Fields Methods
org.bouncycastle.pqc.jcajce.interfaces

public Interface XMSSPrivateKey

extends XMSSKey, PrivateKey
Known Direct Implementers
org.bouncycastle.pqc.jcajce.provider.xmss.BCXMSSPrivateKey
Imports
java.security.PrivateKey

Base interface for an XMSS private key

Field Summary

Inherited from java.security.PrivateKey:
serialVersionUID

Method Summary

Modifier and TypeMethod and Description
public XMSSPrivateKey

Returns:

a key based on the current key that can be used usageCount times.
extractKeyShard
(int
the number of usages the key should have.
usageCount
)

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

public long

Returns:

the index number for the next signature.
getIndex
()

Return the index of the next signature.

public long

Returns:

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

Return the number of usages left for the private key.

Inherited from org.bouncycastle.pqc.jcajce.interfaces.XMSSKey:
getHeightgetTreeDigest

Method Detail

extractKeyShardback to summary
public XMSSPrivateKey extractKeyShard(int usageCount)

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.

Parameters
usageCount:int

the number of usages the key should have.

Returns:XMSSPrivateKey

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

getIndexback to summary
public long getIndex()

Return the index of the next signature.

Returns:long

the index number for the next signature.

getUsagesRemainingback to summary
public long getUsagesRemaining()

Return the number of usages left for the private key.

Returns:long

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