org.bouncycastle.pqc.crypto.xmss

Class XMSSMTPrivateKeyParameters

java.lang.Object

org.bouncycastle.crypto.params.AsymmetricKeyParameter

org.bouncycastle.pqc.crypto.xmss.XMSSMTKeyParameters

org.bouncycastle.pqc.crypto.xmss.XMSSMTPrivateKeyParameters

All Implemented Interfaces:

CipherParameters, XMSSStoreableObjectInterface, Encodable

public final class XMSSMTPrivateKeyParameters
extends XMSSMTKeyParameters
implements XMSSStoreableObjectInterface, Encodable

XMSS^MT Private Key.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XMSSMTPrivateKeyParameters.Builder

Method Summary

Modifier and Type	Method and Description
XMSSMTPrivateKeyParameters	extractKeyShard(int usageCount) Return a key that can be used usageCount times.
byte[]	getEncoded() Return a byte array representing the implementing object.
long	getIndex()
XMSSMTPrivateKeyParameters	getNextKey()
XMSSMTParameters	getParameters()
byte[]	getPublicSeed()
byte[]	getRoot()
byte[]	getSecretKeyPRF()
byte[]	getSecretKeySeed()
long	getUsagesRemaining()
byte[]	toByteArray() Deprecated. use getEncoded() - this method will become private.

Methods inherited from class org.bouncycastle.pqc.crypto.xmss.XMSSMTKeyParameters

getTreeDigest

Methods inherited from class org.bouncycastle.crypto.params.AsymmetricKeyParameter

isPrivate

Methods inherited from class java.lang.Object

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

Method Detail

getEncoded

public byte[] getEncoded()
                  throws java.io.IOException

Description copied from interface: Encodable

Return a byte array representing the implementing object.

Specified by:

getEncoded in interface Encodable

Returns:

a byte array representing the encoding.

Throws:

java.io.IOException - if an issue arises generation the encoding.

toByteArray

@Deprecated
public byte[] toByteArray()

Deprecated. use getEncoded() - this method will become private.

Description copied from interface: XMSSStoreableObjectInterface

Create byte representation of object.

Specified by:

toByteArray in interface XMSSStoreableObjectInterface

Returns:

Byte representation of object.

getIndex

public long getIndex()

getUsagesRemaining

public long getUsagesRemaining()

getSecretKeySeed

public byte[] getSecretKeySeed()

getSecretKeyPRF

public byte[] getSecretKeyPRF()

getPublicSeed

public byte[] getPublicSeed()

getRoot

public byte[] getRoot()

getParameters

public XMSSMTParameters getParameters()

getNextKey

public XMSSMTPrivateKeyParameters getNextKey()

extractKeyShard

public XMSSMTPrivateKeyParameters extractKeyShard(int usageCount)

Return a key that can be used usageCount times.

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

Parameters:

usageCount - the number of usages the key should have.

Returns:

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