Interface MLDSAPrivateKey

  • All Superinterfaces:
    javax.security.auth.Destroyable, java.security.Key, MLDSAKey, java.security.PrivateKey, java.io.Serializable
    All Known Implementing Classes:
    BCMLDSAPrivateKey, MLDSAProxyPrivateKey

    public interface MLDSAPrivateKey
    extends java.security.PrivateKey, MLDSAKey
    • Field Summary

      • Fields inherited from interface java.security.Key

        serialVersionUID
      • Fields inherited from interface java.security.PrivateKey

        serialVersionUID
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      byte[] getPrivateData()
      Return the long form private data for the ML-DSA private key.
      MLDSAPrivateKey getPrivateKey​(boolean preferSeedOnly)
      Return a privateKey which will encode as seed-only or as an expanded-key.
      MLDSAPublicKey getPublicKey()
      Return the public key corresponding to this private key.
      byte[] getSeed()
      Return the seed the private key was generated from (if available).
      • Methods inherited from interface javax.security.auth.Destroyable

        destroy, isDestroyed
      • Methods inherited from interface java.security.Key

        getAlgorithm, getEncoded, getFormat
    • Method Detail

      • getPublicKey

        MLDSAPublicKey getPublicKey()
        Return the public key corresponding to this private key.
        Returns:
        a ML-DSA Public Key
      • getPrivateData

        byte[] getPrivateData()
        Return the long form private data for the ML-DSA private key.
        Returns:
        long form private data for private key.
      • getSeed

        byte[] getSeed()
        Return the seed the private key was generated from (if available).
        Returns:
        the seed for the private key, null if not available.
      • getPrivateKey

        MLDSAPrivateKey getPrivateKey​(boolean preferSeedOnly)
        Return a privateKey which will encode as seed-only or as an expanded-key.
        Parameters:
        preferSeedOnly - if true, return a privateKey which will encode to seed-only if possible.
        Returns:
        a new MLDSAPrivateKey which encodes to either seed-only or expanded-key.