KeyGeneratorSpi

AI-generated Key Takeaways

• KeyGeneratorSpi is a Service Provider Interface (SPI) for the KeyGenerator class, enabling cryptographic providers to implement key generation for specific algorithms.

• It defines abstract methods for key generation, initialization with parameters and randomness sources, which providers must implement.

• engineGenerateKey() generates a secret key, while engineInit() methods initialize the key generator with varying parameters and randomness sources.

• This class is essential for creating and initializing key generators within cryptographic applications.

public abstract class KeyGeneratorSpi extends Object

This class defines the Service Provider Interface (SPI) for the KeyGenerator class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a key generator for a particular algorithm.

See Also

• SecretKey

Public Constructor Summary

KeyGeneratorSpi()

Protected Method Summary

abstract SecretKey	engineGenerateKey() Generates a secret key.
abstract void	engineInit(AlgorithmParameterSpec params, SecureRandom random) Initializes the key generator with the specified parameter set and a user-provided source of randomness.
abstract void	engineInit(SecureRandom random) Initializes the key generator.
abstract void	engineInit(int keysize, SecureRandom random) Initializes this key generator for a certain keysize, using the given source of randomness.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Constructors

public KeyGeneratorSpi ()

Protected Methods

protected abstract SecretKey engineGenerateKey ()

Generates a secret key.

Returns

• the new key

protected abstract void engineInit (AlgorithmParameterSpec params, SecureRandom random)

Initializes the key generator with the specified parameter set and a user-provided source of randomness.

Parameters

params	the key generation parameters
random	the source of randomness for this key generator

Throws

InvalidAlgorithmParameterException	if params is inappropriate for this key generator

protected abstract void engineInit (SecureRandom random)

Initializes the key generator.

Parameters

random	the source of randomness for this generator

protected abstract void engineInit (int keysize, SecureRandom random)

Initializes this key generator for a certain keysize, using the given source of randomness.

Parameters

keysize	the keysize. This is an algorithm-specific metric, specified in number of bits.
random	the source of randomness for this key generator

Throws

InvalidParameterException	if the keysize is wrong or not supported.