Class KyberKeyAttributes

java.lang.Object
com.ibm.crypto.hdwrCCA.provider.KyberKeyAttributes
All Implemented Interfaces:
KeyHWAttributes, Serializable

@Deprecated(since="21.0.11.0", forRemoval=true) public final class KyberKeyAttributes extends Object implements KeyHWAttributes
Deprecated, for removal: This API element is subject to removal in a future version.
Replaced by ML-KEM implementation. This CRYSTALS-Kyber implementation is deprecated and will be removed in a future release, in alignment with NIST's latest recommendations for post-quantum cryptography modernization. Users should transition to the finalized ML-KEM standards.
This class represents key attributes defined for CRYSTALS-Kyber keys.
See Also:
  • Field Summary

    Fields inherited from interface com.ibm.crypto.hdwrCCA.provider.KeyHWAttributes

    serialVersionUID
  • Constructor Summary

    Constructors
    Constructor
    Description
    KyberKeyAttributes(byte keyType)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method constructs a new KyberKeyAttributes object.
    KyberKeyAttributes(byte keyType, byte keyUsage)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method constructs a new KyberKeyAttributes object.
  • Method Summary

    Modifier and Type
    Method
    Description
    byte
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieves the key type attribute.
    byte
    Deprecated, for removal: This API element is subject to removal in a future version.
    Retrieves the key usage attribute.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • KyberKeyAttributes

      public KyberKeyAttributes(byte keyType) throws InvalidParameterException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method constructs a new KyberKeyAttributes object.
      Parameters:
      keyType - the hardware key type
      Throws:
      InvalidParameterException - if the key type or key usage is not valid or not recognized
    • KyberKeyAttributes

      public KyberKeyAttributes(byte keyType, byte keyUsage) throws InvalidParameterException
      Deprecated, for removal: This API element is subject to removal in a future version.
      This method constructs a new KyberKeyAttributes object.
      Parameters:
      keyType - the hardware key type
      keyUsage - the way that the key will be used
      Throws:
      InvalidParameterException - if the key type or key usage is not valid or not recognized
  • Method Details

    • getKeyType

      public byte getKeyType()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the key type attribute.
      Specified by:
      getKeyType in interface KeyHWAttributes
      Returns:
      a byte representing the key type
    • getKeyUsage

      public byte getKeyUsage()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Retrieves the key usage attribute.
      Specified by:
      getKeyUsage in interface KeyHWAttributes
      Returns:
      a byte representing the key usage