Modifier and Type	Class and Description
public static class	XMSSMTPrivateKeyParameters.Builder

Modifier and Type	Field and Description
private volatile BDSStateMap	bdsState
private volatile long	index
private final XMSSMTParameters	params
private final byte[]	publicSeed
private final byte[]	root
private final byte[]	secretKeyPRF
private final byte[]	secretKeySeed
private volatile boolean	used

Access	Constructor and Description
private	XMSSMTPrivateKeyParameters(XMSSMTPrivateKeyParameters.Builder builder)

Method Summary

Modifier and Type	Method and Description
public XMSSMTPrivateKeyParameters	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) Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated. Return a key that can be used usageCount times.
pack-priv BDSStateMap	getBDSState()
public byte[]	getEncoded() Implements org.bouncycastle.util.Encodable.getEncoded. Return a byte array representing the implementing object.
public long	getIndex()
public XMSSMTPrivateKeyParameters	getNextKey() Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated.
public XMSSMTParameters	getParameters()
public byte[]	getPublicSeed()
public byte[]	getRoot()
public byte[]	getSecretKeyPRF()
public byte[]	getSecretKeySeed()
public long	getUsagesRemaining()
pack-priv XMSSMTPrivateKeyParameters	rollKey() Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated.
public byte[]	toByteArray() Implements org.bouncycastle.pqc.crypto.xmss.XMSSStoreableObjectInterface.toByteArray. Deprecated use getEncoded() - this method will become private. Create byte representation of object.

Inherited from org.bouncycastle.pqc.crypto.xmss.XMSSMTKeyParameters:: getTreeDigest

bdsState	back to summary
private volatile BDSStateMap bdsState

index	back to summary
private volatile long index

params	back to summary
private final XMSSMTParameters params

publicSeed	back to summary
private final byte[] publicSeed

root	back to summary
private final byte[] root

secretKeyPRF	back to summary
private final byte[] secretKeyPRF

secretKeySeed	back to summary
private final byte[] secretKeySeed

used	back to summary
private volatile boolean used

XMSSMTPrivateKeyParameters	back to summary
private XMSSMTPrivateKeyParameters(XMSSMTPrivateKeyParameters.Builder builder)

Method Detail

extractKeyShard back to summary

extractKeyShard	back to summary
public XMSSMTPrivateKeyParameters extractKeyShard(int usageCount) Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated. See corresponding docs for further information. Return a key 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:XMSSMTPrivateKeyParameters a key based on the current key that can be used usageCount times.

public XMSSMTPrivateKeyParameters extractKeyShard(int usageCount)

Deprecated

as a consequence of XMSSMTPrivateKeyParameters being deprecated. See corresponding docs for further information.

Return a key 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:XMSSMTPrivateKeyParameters

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

getBDSState	back to summary
pack-priv BDSStateMap getBDSState()

getEncoded	back to summary
public byte[] getEncoded() throws IOException Implements org.bouncycastle.util.Encodable.getEncoded. Doc from org.bouncycastle.util.Encodable.getEncoded. Return a byte array representing the implementing object. Returns:byte[] a byte array representing the encoding. Exceptions IOException: if an issue arises generation the encoding.

getEncoded

back to summary

public byte[] getEncoded() throws IOException

Implements org.bouncycastle.util.Encodable.getEncoded.

Doc from org.bouncycastle.util.Encodable.getEncoded.

Return a byte array representing the implementing object.

Returns:byte[]

a byte array representing the encoding.

Exceptions

IOException:: if an issue arises generation the encoding.

getIndex	back to summary
public long getIndex()

getNextKey	back to summary
public XMSSMTPrivateKeyParameters getNextKey() Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated. See corresponding docs for further information.

getParameters	back to summary
public XMSSMTParameters getParameters()

getPublicSeed	back to summary
public byte[] getPublicSeed()

getRoot	back to summary
public byte[] getRoot()

getSecretKeyPRF	back to summary
public byte[] getSecretKeyPRF()

getSecretKeySeed	back to summary
public byte[] getSecretKeySeed()

getUsagesRemaining	back to summary
public long getUsagesRemaining()

rollKey	back to summary
pack-priv XMSSMTPrivateKeyParameters rollKey() Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated. See corresponding docs for further information.

toByteArray	back to summary
public byte[] toByteArray() Implements org.bouncycastle.pqc.crypto.xmss.XMSSStoreableObjectInterface.toByteArray. Doc from org.bouncycastle.pqc.crypto.xmss.XMSSStoreableObjectInterface.toByteArray. Deprecated use getEncoded() - this method will become private. Create byte representation of object. Returns:byte[] Byte representation of object.

toByteArray

back to summary

public byte[] toByteArray()

Implements org.bouncycastle.pqc.crypto.xmss.XMSSStoreableObjectInterface.toByteArray.

Doc from org.bouncycastle.pqc.crypto.xmss.XMSSStoreableObjectInterface.toByteArray.

Deprecated

use getEncoded() - this method will become private.

Create byte representation of object.

Returns:byte[]: Byte representation of object.

org.bouncycastle.pqc.crypto.xmss back to summary

public Class XMSSMTPrivateKeyParameters.Builder

Class Inheritance

extends Object

java.lang.Object
org.bouncycastle.pqc.crypto.xmss.XMSSMTPrivateKeyParameters.Builder

Field Summary

Modifier and Type	Field and Description
private BDSStateMap	bdsState
private long	index
private long	maxIndex
private final XMSSMTParameters	params
private byte[]	privateKey
private byte[]	publicSeed
private byte[]	root
private byte[]	secretKeyPRF
private byte[]	secretKeySeed
private XMSSParameters	xmss

Constructor Summary

Access	Constructor and Description
public	Builder(XMSSMTParameters params)

Method Summary

Modifier and Type	Method and Description
public XMSSMTPrivateKeyParameters	build() Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated.
public XMSSMTPrivateKeyParameters.Builder	withBDSState(BDSStateMap val)
public XMSSMTPrivateKeyParameters.Builder	withIndex(long val)
public XMSSMTPrivateKeyParameters.Builder	withMaxIndex(long val)
public XMSSMTPrivateKeyParameters.Builder	withPrivateKey(byte[] privateKeyVal)
public XMSSMTPrivateKeyParameters.Builder	withPublicSeed(byte[] val)
public XMSSMTPrivateKeyParameters.Builder	withRoot(byte[] val)
public XMSSMTPrivateKeyParameters.Builder	withSecretKeyPRF(byte[] val)
public XMSSMTPrivateKeyParameters.Builder	withSecretKeySeed(byte[] val)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bdsState	back to summary
private BDSStateMap bdsState

index	back to summary
private long index

maxIndex	back to summary
private long maxIndex

params	back to summary
private final XMSSMTParameters params

privateKey	back to summary
private byte[] privateKey

publicSeed	back to summary
private byte[] publicSeed

root	back to summary
private byte[] root

secretKeyPRF	back to summary
private byte[] secretKeyPRF

secretKeySeed	back to summary
private byte[] secretKeySeed

xmss	back to summary
private XMSSParameters xmss

Constructor Detail

Builder	back to summary
public Builder(XMSSMTParameters params)

Method Detail

build	back to summary
public XMSSMTPrivateKeyParameters build() Deprecated as a consequence of `XMSSMTPrivateKeyParameters` being deprecated. See corresponding docs for further information.

withBDSState	back to summary
public XMSSMTPrivateKeyParameters.Builder withBDSState(BDSStateMap val)

withIndex	back to summary
public XMSSMTPrivateKeyParameters.Builder withIndex(long val)

withMaxIndex	back to summary
public XMSSMTPrivateKeyParameters.Builder withMaxIndex(long val)

withPrivateKey	back to summary
public XMSSMTPrivateKeyParameters.Builder withPrivateKey(byte[] privateKeyVal)

withPublicSeed	back to summary
public XMSSMTPrivateKeyParameters.Builder withPublicSeed(byte[] val)

withRoot	back to summary
public XMSSMTPrivateKeyParameters.Builder withRoot(byte[] val)

withSecretKeyPRF	back to summary
public XMSSMTPrivateKeyParameters.Builder withSecretKeyPRF(byte[] val)

withSecretKeySeed	back to summary
public XMSSMTPrivateKeyParameters.Builder withSecretKeySeed(byte[] val)

public final Class XMSSMTPrivateKeyParameters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XMSSMTPrivateKeyParameters.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail