Class XMSSPrivateKeyParameters

All Implemented Interfaces:
CipherParameters, XMSSStoreableObjectInterface, Encodable

public final class XMSSPrivateKeyParameters extends XMSSKeyParameters implements XMSSStoreableObjectInterface, Encodable
XMSS Private Key.
  • Method Details Link icon

    • getUsagesRemaining Link icon

      public long getUsagesRemaining()
    • getEncoded Link icon

      public byte[] getEncoded() throws 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:
      IOException - if an issue arises generation the encoding.
    • getNextKey Link icon

      public XMSSPrivateKeyParameters getNextKey()
    • extractKeyShard Link icon

      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 Link icon

      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 Link icon

      public int getIndex()
    • getSecretKeySeed Link icon

      public byte[] getSecretKeySeed()
    • getSecretKeyPRF Link icon

      public byte[] getSecretKeyPRF()
    • getPublicSeed Link icon

      public byte[] getPublicSeed()
    • getRoot Link icon

      public byte[] getRoot()
    • getParameters Link icon

      public XMSSParameters getParameters()