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:
Destroyable, CipherParameters, XMSSStoreableObjectInterface, Encodable
@Deprecated public final class XMSSMTPrivateKeyParameters extends XMSSMTKeyParameters implements XMSSStoreableObjectInterface, Encodable, Destroyable
Deprecated.
use XMSSMTPrivateKeyParameters instead.
XMSS^MT Private Key.

  • Method Details

    • getEncoded

      public byte[] getEncoded() throws IOException
      Deprecated.
      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:
      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()
      Deprecated.

    • getUsagesRemaining

      public long getUsagesRemaining()
      Deprecated.

    • getSecretKeySeed

      public byte[] getSecretKeySeed()
      Deprecated.

    • getSecretKeyPRF

      public byte[] getSecretKeyPRF()
      Deprecated.

    • getPublicSeed

      public byte[] getPublicSeed()
      Deprecated.

    • getRoot

      public byte[] getRoot()
      Deprecated.

    • getParameters

      public XMSSMTParameters getParameters()
      Deprecated.

    • getNextKey

      public XMSSMTPrivateKeyParameters getNextKey()
      Deprecated.

    • extractKeyShard

      public XMSSMTPrivateKeyParameters extractKeyShard(int usageCount)
      Deprecated.
      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.

    • destroy

      public void destroy()
      Deprecated.
      Destroy this key, zeroizing the secret key material it holds: the seed the WOTS+ secret keys are derived from, the PRF key that randomizes message digests, and the WOTS+ secret keys the per-layer BDS traversal states retain for the leaves they last processed.

      The public seed, the root, the index and the traversal states' tree nodes are retained - none of them is secret. After destruction isDestroyed() returns true and getSecretKeySeed(), getSecretKeyPRF(), getEncoded(), getNextKey() and extractKeyShard(int) throw IllegalStateException; a signature attempt fails before the index is advanced. Keys previously split off this one hold their own copies of the seeds and are unaffected.

      Specified by:
      destroy in interface Destroyable

    • isDestroyed

      public boolean isDestroyed()
      Deprecated.
      Specified by:
      isDestroyed in interface Destroyable