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

Field Summary

Modifier and Type	Field and Description
private volatile BDS	bdsState BDS state.
private final XMSSParameters	params XMSS parameters object.
private final byte[]	publicSeed Public seed for the randomization of hashes.
private final byte[]	root Public root of binary tree.
private final byte[]	secretKeyPRF Secret for the randomization of message digests during signature creation.
private final byte[]	secretKeySeed Secret for the derivation of WOTS+ secret keys.

Inherited from org.bouncycastle.pqc.crypto.xmss.XMSSKeyParameters:: SHA_256 SHA_512 SHAKE128 SHAKE256

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

Method Summary

Modifier and Type	Method and Description
public XMSSPrivateKeyParameters	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 `XMSSPrivateKeyParameters` being deprecated. Return a key that can be used usageCount times.
pack-priv BDS	getBDSState()
public byte[]	getEncoded() Implements org.bouncycastle.util.Encodable.getEncoded. Return a byte array representing the implementing object.
public int	getIndex()
public XMSSPrivateKeyParameters	getNextKey() Deprecated as a consequence of `XMSSPrivateKeyParameters` being deprecated.
public XMSSParameters	getParameters()
public byte[]	getPublicSeed()
public byte[]	getRoot()
public byte[]	getSecretKeyPRF()
public byte[]	getSecretKeySeed()
public long	getUsagesRemaining()
pack-priv XMSSPrivateKeyParameters	rollKey() Deprecated as a consequence of `XMSSPrivateKeyParameters` 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.XMSSKeyParameters:: getTreeDigest

Field Detail

bdsState	back to summary
private volatile BDS bdsState BDS state.

params	back to summary
private final XMSSParameters params XMSS parameters object.

publicSeed	back to summary
private final byte[] publicSeed Public seed for the randomization of hashes.

root	back to summary
private final byte[] root Public root of binary tree.

secretKeyPRF	back to summary
private final byte[] secretKeyPRF Secret for the randomization of message digests during signature creation.

secretKeySeed	back to summary
private final byte[] secretKeySeed Secret for the derivation of WOTS+ secret keys.

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

Method Detail

extractKeyShard back to summary

extractKeyShard	back to summary
public XMSSPrivateKeyParameters extractKeyShard(int usageCount) Deprecated as a consequence of `XMSSPrivateKeyParameters` 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:XMSSPrivateKeyParameters a key based on the current key that can be used usageCount times.

public XMSSPrivateKeyParameters extractKeyShard(int usageCount)

Deprecated

as a consequence of XMSSPrivateKeyParameters 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:XMSSPrivateKeyParameters

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

getBDSState	back to summary
pack-priv BDS 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 int getIndex()

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

getParameters	back to summary
public XMSSParameters 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 XMSSPrivateKeyParameters rollKey() Deprecated as a consequence of `XMSSPrivateKeyParameters` 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 XMSSPrivateKeyParameters.Builder

Class Inheritance

extends Object

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

Field Summary

Modifier and Type	Field and Description
private BDS	bdsState
private int	index
private int	maxIndex
private final XMSSParameters	params
private byte[]	privateKey
private byte[]	publicSeed
private byte[]	root
private byte[]	secretKeyPRF
private byte[]	secretKeySeed

Constructor Summary

Access	Constructor and Description
public	Builder(XMSSParameters params)

Method Summary

Modifier and Type	Method and Description
public XMSSPrivateKeyParameters	build() Deprecated as a consequence of `XMSSPrivateKeyParameters` being deprecated.
public XMSSPrivateKeyParameters.Builder	withBDSState(BDS valBDS)
public XMSSPrivateKeyParameters.Builder	withIndex(int val)
public XMSSPrivateKeyParameters.Builder	withMaxIndex(int val)
public XMSSPrivateKeyParameters.Builder	withPrivateKey(byte[] privateKeyVal)
public XMSSPrivateKeyParameters.Builder	withPublicSeed(byte[] val)
public XMSSPrivateKeyParameters.Builder	withRoot(byte[] val)
public XMSSPrivateKeyParameters.Builder	withSecretKeyPRF(byte[] val)
public XMSSPrivateKeyParameters.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 BDS bdsState

index	back to summary
private int index

maxIndex	back to summary
private int maxIndex

params	back to summary
private final XMSSParameters 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

Constructor Detail

Builder	back to summary
public Builder(XMSSParameters params)

Method Detail

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

withBDSState	back to summary
public XMSSPrivateKeyParameters.Builder withBDSState(BDS valBDS)

withIndex	back to summary
public XMSSPrivateKeyParameters.Builder withIndex(int val)

withMaxIndex	back to summary
public XMSSPrivateKeyParameters.Builder withMaxIndex(int val)

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

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

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

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

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

public final Class XMSSPrivateKeyParameters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class XMSSPrivateKeyParameters.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail