Package org.bouncycastle.pqc.crypto.xmss
Class XMSSPrivateKeyParameters
- java.lang.Object
-
- org.bouncycastle.crypto.params.AsymmetricKeyParameter
-
- org.bouncycastle.pqc.crypto.xmss.XMSSKeyParameters
-
- org.bouncycastle.pqc.crypto.xmss.XMSSPrivateKeyParameters
-
- All Implemented Interfaces:
CipherParameters,XMSSStoreableObjectInterface,Encodable
public final class XMSSPrivateKeyParameters extends XMSSKeyParameters implements XMSSStoreableObjectInterface, Encodable
XMSS Private Key.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXMSSPrivateKeyParameters.Builder
-
Field Summary
-
Fields inherited from class org.bouncycastle.pqc.crypto.xmss.XMSSKeyParameters
SHA_256, SHA_512, SHAKE128, SHAKE256
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description XMSSPrivateKeyParametersextractKeyShard(int usageCount)Return a key that can be used usageCount times.byte[]getEncoded()Return a byte array representing the implementing object.intgetIndex()XMSSPrivateKeyParametersgetNextKey()XMSSParametersgetParameters()byte[]getPublicSeed()byte[]getRoot()byte[]getSecretKeyPRF()byte[]getSecretKeySeed()longgetUsagesRemaining()byte[]toByteArray()Deprecated.use getEncoded() - this method will become private.-
Methods inherited from class org.bouncycastle.pqc.crypto.xmss.XMSSKeyParameters
getTreeDigest
-
Methods inherited from class org.bouncycastle.crypto.params.AsymmetricKeyParameter
isPrivate
-
-
-
-
Method Detail
-
getUsagesRemaining
public long getUsagesRemaining()
-
getEncoded
public byte[] getEncoded() throws java.io.IOExceptionDescription copied from interface:EncodableReturn a byte array representing the implementing object.- Specified by:
getEncodedin interfaceEncodable- Returns:
- a byte array representing the encoding.
- Throws:
java.io.IOException- if an issue arises generation the encoding.
-
getNextKey
public XMSSPrivateKeyParameters getNextKey()
-
extractKeyShard
public XMSSPrivateKeyParameters 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.
-
toByteArray
public byte[] toByteArray()
Deprecated.use getEncoded() - this method will become private.Description copied from interface:XMSSStoreableObjectInterfaceCreate byte representation of object.- Specified by:
toByteArrayin interfaceXMSSStoreableObjectInterface- Returns:
- Byte representation of object.
-
getIndex
public int getIndex()
-
getSecretKeySeed
public byte[] getSecretKeySeed()
-
getSecretKeyPRF
public byte[] getSecretKeyPRF()
-
getPublicSeed
public byte[] getPublicSeed()
-
getRoot
public byte[] getRoot()
-
getParameters
public XMSSParameters getParameters()
-
-