Module ibm.crypto.hdwrcca
Package com.ibm.crypto.hdwrCCA.provider

Class MLKEMKeyFactory

java.lang.Object
java.security.KeyFactorySpi
com.ibm.crypto.hdwrCCA.provider.MLKEMKeyFactory
public class MLKEMKeyFactory extends KeyFactorySpi
This class implements the ML-KEM key factory of the IBMJCECCA provider.

This documentation describes a Service Provider Interface. It is provided for implementation insight only. This class is not intended to be called directly by application developers. Please consult the 'Java Cryptography Architecture Standard' for details on how to use this interface through a public standard class.

  • Constructor Details

    • MLKEMKeyFactory

      public MLKEMKeyFactory()
      Creates a new instance of this class.

  • Method Details

    • engineGeneratePublic

      protected PublicKey engineGeneratePublic(KeySpec keySpec) throws InvalidKeySpecException
      Generates a public key object from the provided key specification (key material).
      Specified by:
      engineGeneratePublic in class KeyFactorySpi
      Parameters:
      keySpec - the specification (key material) of the public key. Two key specs are supported including MLKEMPublicKeySpec and KeyLabelKeySpec. In the case of using a KeyLabelKeySpec, the key spec must point to an already existing key within the PKDS.
      Returns:
      the public key representing the material contained within the specified key spec.
      Throws:
      InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a public key.

    • engineGeneratePrivate

      protected PrivateKey engineGeneratePrivate(KeySpec keySpec) throws InvalidKeySpecException
      Generates a private key object from the provided key specification (key material).
      Specified by:
      engineGeneratePrivate in class KeyFactorySpi
      Parameters:
      keySpec - the specification (key material) of the private key. Two key specs are supported including MLKEMPrivateKeySpec and KeyLabelKeySpec. In the case of using a KeyLabelKeySpec the key spec must point to an already existing key within the PKDS.
      Returns:
      the private key representing the material contained within the specified key spec.
      Throws:
      InvalidKeySpecException - if the given key specification is inappropriate for this key factory to produce a private key.

    • engineGetKeySpec

      protected <T extends KeySpec> T engineGetKeySpec(Key key, Class<T> keySpec) throws InvalidKeySpecException
      Returns a specification (key material) of the given key object in the requested format.
      Specified by:
      engineGetKeySpec in class KeyFactorySpi
      Parameters:
      key - the key object, must be either MLKEMPublicKey or MLKEMPrivateKey
      keySpec - the requested format in which the key material shall be returned
      Returns:
      the underlying key specification (key material) in the requested format.
      Throws:
      InvalidKeySpecException - if the requested key specification is inappropriate for the given key, or the given key cannot be processed (e.g., the given key has an unrecognized algorithm or format).

    • engineTranslateKey

      protected Key engineTranslateKey(Key key) throws InvalidKeyException
      Translates a key object, whose provider may be unknown or potentially untrusted, into a corresponding key object of this key factory.
      Specified by:
      engineTranslateKey in class KeyFactorySpi
      Parameters:
      key - the key whose provider is unknown or untrusted. Key types acceptable are PublicKey and PrivateKey
      Returns:
      the translated key.
      Throws:
      InvalidKeyException - if the given key cannot be processed by this key factory.