Package org.bouncycastle.pqc.jcajce.provider.xmss

Class BCXMSSPrivateKey

  • All Implemented Interfaces:
    java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable, XMSSKey, XMSSPrivateKey
    public class BCXMSSPrivateKey
extends java.lang.Object
implements java.security.PrivateKey, XMSSPrivateKey
    See Also:
    Serialized Form

    • Method Detail

      • getIndex

        public long getIndex()
        Description copied from interface: XMSSPrivateKey
        Return the index of the next signature.
        Specified by:
        getIndex in interface XMSSPrivateKey
        Returns:
        the index number for the next signature.

      • getUsagesRemaining

        public long getUsagesRemaining()
        Description copied from interface: XMSSPrivateKey
        Return the number of usages left for the private key.
        Specified by:
        getUsagesRemaining in interface XMSSPrivateKey
        Returns:
        the number of times the key can be used before it is exhausted.

      • extractKeyShard

        public XMSSPrivateKey extractKeyShard​(int usageCount)
        Description copied from interface: XMSSPrivateKey
        Return a key representing a shard of the key space that can be used usageCount times.

        Note: this will use the range [index...index + usageCount) for the current key.

        Specified by:
        extractKeyShard in interface XMSSPrivateKey
        Parameters:
        usageCount - the number of usages the key should have.
        Returns:
        a key based on the current key that can be used usageCount times.

      • getAlgorithm

        public java.lang.String getAlgorithm()
        Specified by:
        getAlgorithm in interface java.security.Key

      • getFormat

        public java.lang.String getFormat()
        Specified by:
        getFormat in interface java.security.Key

      • getEncoded

        public byte[] getEncoded()
        Specified by:
        getEncoded in interface java.security.Key

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getHeight

        public int getHeight()
        Specified by:
        getHeight in interface XMSSKey

      • getTreeDigest

        public java.lang.String getTreeDigest()
        Specified by:
        getTreeDigest in interface XMSSKey