KeyPairGenerator
public abstract class KeyPairGeneratorSpi extends Object
This class defines the Service Provider Interface (SPI) for the KeyPairGenerator
class, which is used to generate pairs of public and private keys.
All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a key pair generator for a particular algorithm.
In case the client does not explicitly initialize the KeyPairGenerator
(via a call to an initialize
method), each provider must supply (and document) a default initialization. See the Keysize Restriction sections of the JDK Providers document for information on the KeyPairGenerator defaults used by JDK providers. However, note that defaults may vary across different providers. Additionally, the default value for a provider may change in a future version. Therefore, it is recommended to explicitly initialize the KeyPairGenerator
instead of relying on provider-specific defaults.
Constructor | Description |
---|---|
KeyPairGeneratorSpi() |
Constructor for subclasses to call. |
Modifier and Type | Method | Description |
---|---|---|
abstract KeyPair |
generateKeyPair() |
Generates a key pair. |
abstract void |
initialize |
Initializes the key pair generator for a certain keysize, using the default parameter set. |
void |
initialize |
Initializes the key pair generator using the specified parameter set and user-provided source of randomness. |
public KeyPairGeneratorSpi()
public abstract void initialize(int keysize, SecureRandom random)
keysize
- the keysize. This is an algorithm-specific metric, such as modulus length, specified in number of bits.random
- the source of randomness for this generator.InvalidParameterException
- if the keysize
is not supported by this KeyPairGeneratorSpi
object.public void initialize(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException
This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.) It may be overridden by a provider to initialize the key pair generator. Such an override is expected to throw an InvalidAlgorithmParameterException
if a parameter is inappropriate for this key pair generator. If this method is not overridden, it always throws an UnsupportedOperationException
.
params
- the parameter set used to generate the keys.random
- the source of randomness for this generator.InvalidAlgorithmParameterException
- if the given parameters are inappropriate for this key pair generator.public abstract KeyPair generateKeyPair()
KeyPair
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/security/KeyPairGeneratorSpi.html