KeyPairGenerator
class is used to generate pairs of
public and private keys. Key pair generators are constructed using the
getInstance
factory methods (static methods that
return instances of a given class).
A Key pair generator for a particular algorithm creates a public/private key pair that can be used with this algorithm. It also associates algorithm-specific parameters with each of the generated keys.
There are two ways to generate a key pair: in an algorithm-independent manner, and in an algorithm-specific manner. The only difference between the two is the initialization of the object:
All key pair generators share the concepts of a keysize and a
source of randomness. The keysize is interpreted differently for different
algorithms (e.g., in the case of the DSA algorithm, the keysize
corresponds to the length of the modulus).
There is an
initialize
method in this KeyPairGenerator
class that takes these two universally
shared types of arguments. There is also one that takes just a
keysize
argument, and uses the SecureRandom
implementation of the highest-priority installed provider as the source
of randomness. (If none of the installed providers supply an implementation
of SecureRandom
, a system-provided source of randomness is
used.)
Since no other parameters are specified when you call the above
algorithm-independent initialize
methods, it is up to the
provider what to do about the algorithm-specific parameters (if any) to be
associated with each of the keys.
If the algorithm is the DSA algorithm, and the keysize (modulus
size) is 512, 768, 1024, or 2048, then the Sun provider uses a set of
precomputed values for the p
, q
, and
g
parameters. If the modulus size is not one of the above
values, the Sun provider creates a new set of parameters. Other
providers might have precomputed parameter sets for more than just the
modulus sizes mentioned above. Still others might not have a list of
precomputed parameters at all and instead always create new parameter sets.
For situations where a set of algorithm-specific parameters already
exists (e.g., so-called community parameters in DSA), there are two
initialize
methods that have an AlgorithmParameterSpec
argument. One also has a SecureRandom
argument, while
the other uses the SecureRandom
implementation of the highest-priority installed provider as the source
of randomness. (If none of the installed providers supply an implementation
of SecureRandom
, a system-provided source of randomness is
used.)
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.
Note that this class is abstract and extends from
KeyPairGeneratorSpi
for historical reasons.
Application developers should only take notice of the methods defined in
this KeyPairGenerator
class; all the methods in
the superclass are intended for cryptographic service providers who wish to
supply their own implementations of key pair generators.
Every implementation of the Java platform is required to support the
following standard KeyPairGenerator
algorithms and keysizes in
parentheses:
DiffieHellman
(1024, 2048, 4096)DSA
(1024, 2048)RSA
(1024, 2048, 4096)java.security.spec.AlgorithmParameterSpec
Modifier and Type | Class and Description |
---|---|
private static class |
Modifier and Type | Field and Description |
---|---|
private final String | |
private static final Debug | |
pack-priv Provider | |
private static final boolean |
Access | Constructor and Description |
---|---|
protected | KeyPairGenerator(String
the standard string name of the algorithm.
See the KeyPairGenerator section in the
Java Security Standard Algorithm Names Specification
for information about standard algorithm names. algorithm)Creates a |
Modifier and Type | Method and Description |
---|---|
pack-priv void | |
public KeyPair | Returns: the generated key pairImplements abstract java. Generates a key pair. |
public final KeyPair | |
public String | Returns: the standard string name of the algorithm.Returns the standard name of the algorithm for this key pair generator. |
private static KeyPairGenerator | |
public static KeyPairGenerator | Returns: the newKeyPairGenerator objectthe standard string name of the algorithm.
See the KeyPairGenerator section in the
Java Security Standard Algorithm Names Specification
for information about standard algorithm names. algorithm)Returns a |
public static KeyPairGenerator | Returns: the newKeyPairGenerator objectthe standard string name of the algorithm.
See the KeyPairGenerator section in the
Java Security Standard Algorithm Names Specification
for information about standard algorithm names. algorithm, String the string name of the provider. provider)Returns a |
public static KeyPairGenerator | Returns: the newKeyPairGenerator objectthe standard string name of the algorithm.
See the KeyPairGenerator section in the
Java Security Standard Algorithm Names Specification
for information about standard algorithm names. algorithm, Provider the provider. provider)Returns a |
public final Provider | Returns: the provider of this key pair generator objectReturns the provider of this key pair generator object. |
public void | initialize(int
the keysize. This is an
algorithm-specific metric, such as modulus length, specified in
number of bits. keysize)Initializes the key pair generator for a certain keysize using
a default parameter set and the |
public void | initialize(int
the keysize. This is an
algorithm-specific metric, such as modulus length, specified in
number of bits. keysize, SecureRandom the source of randomness. random)Implements abstract java. Initializes the key pair generator for a certain keysize with the given source of randomness (and a default parameter set). |
public void | initialize(AlgorithmParameterSpec
the parameter set used to generate the keys. params)Initializes the key pair generator using the specified parameter
set and the |
public void | initialize(AlgorithmParameterSpec
the parameter set used to generate the keys. params, SecureRandom the source of randomness. random)Overrides java. Initializes the key pair generator with the given parameter set and source of randomness. |
algorithm | back to summary |
---|---|
private final String algorithm |
pdebug | back to summary |
---|---|
private static final Debug pdebug |
provider | back to summary |
---|---|
pack-priv Provider provider |
skipDebug | back to summary |
---|---|
private static final boolean skipDebug |
KeyPairGenerator | back to summary |
---|---|
protected KeyPairGenerator(String algorithm) Creates a
|
disableFailover | back to summary |
---|---|
pack-priv void disableFailover() |
generateKeyPair | back to summary |
---|---|
public KeyPair generateKeyPair() Implements abstract java. Generates a key pair. If this This will generate a new key pair every time it is called. This method is functionally equivalent to
|
genKeyPair | back to summary |
---|---|
public final KeyPair genKeyPair() Generates a key pair. If this This will generate a new key pair every time it is called. This method is functionally equivalent to
|
getAlgorithm | back to summary |
---|---|
public String getAlgorithm() Returns the standard name of the algorithm for this key pair generator. See the KeyPairGenerator section in the Java Security Standard Algorithm Names Specification for information about standard algorithm names.
|
getInstance | back to summary |
---|---|
private static KeyPairGenerator getInstance(GetInstance. |
getInstance | back to summary |
---|---|
public static KeyPairGenerator getInstance(String algorithm) throws NoSuchAlgorithmException Returns a This method traverses the list of registered security Providers,
starting with the most preferred Provider.
A new Note that the list of registered providers may be retrieved via
the Implementation Note The JDK Reference Implementation additionally uses the
|
getInstance | back to summary |
---|---|
public static KeyPairGenerator getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException Returns a A new Note that the list of registered providers may be retrieved via
the
|
getInstance | back to summary |
---|---|
public static KeyPairGenerator getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException Returns a A new
|
getProvider | back to summary |
---|---|
public final Provider getProvider() Returns the provider of this key pair generator object.
|
initialize | back to summary |
---|---|
public void initialize(int keysize) Initializes the key pair generator for a certain keysize using
a default parameter set and the
|
initialize | back to summary |
---|---|
public void initialize(int keysize, SecureRandom random) Implements abstract java. Initializes the key pair generator for a certain keysize with the given source of randomness (and a default parameter set).
|
initialize | back to summary |
---|---|
public void initialize(AlgorithmParameterSpec params) throws InvalidAlgorithmParameterException Initializes the key pair generator using the specified parameter
set and the This concrete method has been added to this previously-defined
abstract class.
This method calls the KeyPairGeneratorSpi
|
initialize | back to summary |
---|---|
public void initialize(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException Overrides java. Initializes the key pair generator with the given parameter set and source of randomness. This concrete method has been added to this previously-defined
abstract class.
This method calls the KeyPairGeneratorSpi
|
Modifier and Type | Field and Description |
---|---|
private static final int | |
private static final int | |
private static final int | |
private int | |
private AlgorithmParameterSpec | |
private SecureRandom | |
private int | |
private final Object | |
private Iterator | |
private volatile KeyPairGeneratorSpi |
Access | Constructor and Description |
---|---|
pack-priv | |
pack-priv |
Modifier and Type | Method and Description |
---|---|
pack-priv void | |
public KeyPair | |
public void | initialize(int
the keysize. This is an
algorithm-specific metric, such as modulus length, specified in
number of bits. keysize, SecureRandom the source of randomness. random)Overrides java. Initializes the key pair generator for a certain keysize with the given source of randomness (and a default parameter set). |
public void | initialize(AlgorithmParameterSpec
the parameter set used to generate the keys. params, SecureRandom the source of randomness. random)Overrides java. Initializes the key pair generator with the given parameter set and source of randomness. |
private KeyPairGeneratorSpi | nextSpi(KeyPairGeneratorSpi oldSpi, boolean reinit)
Update the active spi of this class and return the next implementation for failover. |
I_NONE | back to summary |
---|---|
private static final int I_NONE |
I_PARAMS | back to summary |
---|---|
private static final int I_PARAMS |
I_SIZE | back to summary |
---|---|
private static final int I_SIZE |
initKeySize | back to summary |
---|---|
private int initKeySize |
initParams | back to summary |
---|---|
private AlgorithmParameterSpec initParams |
initRandom | back to summary |
---|---|
private SecureRandom initRandom |
initType | back to summary |
---|---|
private int initType |
lock | back to summary |
---|---|
private final Object lock |
serviceIterator | back to summary |
---|---|
private Iterator<Provider. |
spi | back to summary |
---|---|
private volatile KeyPairGeneratorSpi spi |
Delegate | back to summary |
---|---|
pack-priv Delegate(KeyPairGeneratorSpi spi, String algorithm) |
Delegate | back to summary |
---|---|
pack-priv Delegate(GetInstance. |
disableFailover | back to summary |
---|---|
pack-priv void disableFailover() |
generateKeyPair | back to summary |
---|---|
public KeyPair generateKeyPair() Overrides java. Doc from java. Generates a key pair. If this This will generate a new key pair every time it is called. This method is functionally equivalent to
|
initialize | back to summary |
---|---|
public void initialize(int keysize, SecureRandom random) Overrides java. Doc from java. Initializes the key pair generator for a certain keysize with the given source of randomness (and a default parameter set).
|
initialize | back to summary |
---|---|
public void initialize(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException Overrides java. Doc from java. Initializes the key pair generator with the given parameter set and source of randomness. This concrete method has been added to this previously-defined
abstract class.
This method calls the KeyPairGeneratorSpi
|
nextSpi | back to summary |
---|---|
private KeyPairGeneratorSpi nextSpi(KeyPairGeneratorSpi oldSpi, boolean reinit) Update the active spi of this class and return the next
implementation for failover. If no more implementations are
available, this method returns |