org.bouncycastle.pqc.jcajce.provider.xmss

Class BCXMSSPrivateKey

java.lang.Object

org.bouncycastle.pqc.jcajce.provider.xmss.BCXMSSPrivateKey

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable, XMSSKey, XMSSPrivateKey

public class BCXMSSPrivateKey
extends java.lang.Object
implements java.security.PrivateKey, XMSSPrivateKey

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BCXMSSPrivateKey(ASN1ObjectIdentifier treeDigest, XMSSPrivateKeyParameters keyParams)
BCXMSSPrivateKey(PrivateKeyInfo keyInfo)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
XMSSPrivateKey	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.
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

BCXMSSPrivateKey

public BCXMSSPrivateKey(ASN1ObjectIdentifier treeDigest,
                        XMSSPrivateKeyParameters keyParams)

BCXMSSPrivateKey

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

Throws:

java.io.IOException

Method Detail

getIndex

public long getIndex()

Description copied from interface: XMSSPrivateKey

Return the index of the next signature.

Specified by:

getIndex in interface XMSSPrivateKey

Returns:

the index number for the next signature.

getUsagesRemaining

public long getUsagesRemaining()

Description copied from interface: XMSSPrivateKey

Return the number of usages left for the private key.

Specified by:

getUsagesRemaining in interface XMSSPrivateKey

Returns:

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

extractKeyShard

public XMSSPrivateKey extractKeyShard(int usageCount)

Description copied from interface: XMSSPrivateKey

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 XMSSPrivateKey

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 XMSSKey

getTreeDigest

public java.lang.String getTreeDigest()

Specified by:

getTreeDigest in interface XMSSKey