Stay organized with collections
Save and categorize content based on your preferences.
DSAKeyPairGenerator
public
interface
DSAKeyPairGenerator
| java.security.interfaces.DSAKeyPairGenerator
|
An interface to an object capable of generating DSA key pairs.
The initialize methods may each be called any number
of times. If no initialize method is called on a
DSAKeyPairGenerator, each provider that implements this interface
should supply (and document) a default initialization. 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 DSAKeyPairGenerator instead
of relying on provider-specific defaults.
Users wishing to indicate DSA-specific parameters, and to generate a key
pair suitable for use with the DSA algorithm typically
- Get a key pair generator for the DSA algorithm by calling the
KeyPairGenerator
getInstance method with "DSA"
as its argument.
- Check if the returned key pair generator is an instance of
DSAKeyPairGenerator before casting the result to a DSAKeyPairGenerator
and calling one of the
initialize methods from this
DSAKeyPairGenerator interface.
- Generate a key pair by calling the
generateKeyPair
method of the KeyPairGenerator class.
Note: it is not always necessary to do algorithm-specific
initialization for a DSA key pair generator. That is, it is not always
necessary to call an initialize method in this interface.
Algorithm-independent initialization using the initialize method
in the KeyPairGenerator
interface is all that is needed when you accept defaults for algorithm-specific
parameters.
Note: Some earlier implementations of this interface may not support
larger values of DSA parameters such as 3072-bit.
Summary
Public methods |
|---|
abstract
void
|
initialize(DSAParams params, SecureRandom random)
Initializes the key pair generator using the DSA family parameters
(p,q and g) and an optional SecureRandom bit source.
|
abstract
void
|
initialize(int modlen, boolean genParams, SecureRandom random)
Initializes the key pair generator for a given modulus length
(instead of parameters), and an optional SecureRandom bit source.
|
Public methods
initialize
public abstract void initialize (DSAParams params,
SecureRandom random)
Initializes the key pair generator using the DSA family parameters
(p,q and g) and an optional SecureRandom bit source. If a
SecureRandom bit source is needed but not supplied, i.e. null, a
default SecureRandom instance will be used.
| Parameters |
|---|
params |
DSAParams: the parameters to use to generate the keys. |
random |
SecureRandom: the random bit source to use to generate key bits;
can be null. |
initialize
public abstract void initialize (int modlen,
boolean genParams,
SecureRandom random)
Initializes the key pair generator for a given modulus length
(instead of parameters), and an optional SecureRandom bit source.
If a SecureRandom bit source is needed but not supplied, i.e.
null, a default SecureRandom instance will be used.
If genParams is true, this method generates new
p, q and g parameters. If it is false, the method uses precomputed
parameters for the modulus length requested. If there are no
precomputed parameters for that modulus length, an exception will be
thrown.
| Parameters |
|---|
modlen |
int: the modulus length in bits. Valid values are any
multiple of 64 between 512 and 1024, inclusive, 2048, and 3072. |
genParams |
boolean: whether or not to generate new parameters for
the modulus length requested. |
random |
SecureRandom: the random bit source to use to generate key bits;
can be null. |
| Throws |
|---|
InvalidParameterException |
if modlen is
invalid, or unsupported, or if genParams is false and there
are no precomputed parameters for the requested modulus length. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# DSAKeyPairGenerator\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\nDSAKeyPairGenerator\n===================\n\n\n`\npublic\n\n\ninterface\nDSAKeyPairGenerator\n`\n\n\n`\n\n\n`\n\n|----------------------------------------------|\n| java.security.interfaces.DSAKeyPairGenerator |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nAn interface to an object capable of generating DSA key pairs.\n\nThe `initialize` methods may each be called any number\nof times. If no `initialize` method is called on a\nDSAKeyPairGenerator, each provider that implements this interface\nshould supply (and document) a default initialization. Note that\ndefaults may vary across different providers. Additionally, the default\nvalue for a provider may change in a future version. Therefore, it is\nrecommended to explicitly initialize the DSAKeyPairGenerator instead\nof relying on provider-specific defaults.\n\nUsers wishing to indicate DSA-specific parameters, and to generate a key\npair suitable for use with the DSA algorithm typically\n\n1. Get a key pair generator for the DSA algorithm by calling the KeyPairGenerator `getInstance` method with \"DSA\" as its argument.\n2. Check if the returned key pair generator is an instance of DSAKeyPairGenerator before casting the result to a DSAKeyPairGenerator and calling one of the `initialize` methods from this DSAKeyPairGenerator interface.\n3. Generate a key pair by calling the `generateKeyPair` method of the KeyPairGenerator class.\n\nNote: it is not always necessary to do algorithm-specific\ninitialization for a DSA key pair generator. That is, it is not always\nnecessary to call an `initialize` method in this interface.\nAlgorithm-independent initialization using the `initialize` method\nin the KeyPairGenerator\ninterface is all that is needed when you accept defaults for algorithm-specific\nparameters.\n\nNote: Some earlier implementations of this interface may not support\nlarger values of DSA parameters such as 3072-bit. \n**See also:**\n\n- [KeyPairGenerator](/reference/java/security/KeyPairGenerator)\n\nSummary\n-------\n\n| ### Public methods ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract void` | ` `[initialize](/reference/java/security/interfaces/DSAKeyPairGenerator#initialize(java.security.interfaces.DSAParams,%20java.security.SecureRandom))`(`[DSAParams](/reference/java/security/interfaces/DSAParams)` params, `[SecureRandom](/reference/java/security/SecureRandom)` random) ` Initializes the key pair generator using the DSA family parameters (p,q and g) and an optional SecureRandom bit source. |\n| ` abstract void` | ` `[initialize](/reference/java/security/interfaces/DSAKeyPairGenerator#initialize(int,%20boolean,%20java.security.SecureRandom))`(int modlen, boolean genParams, `[SecureRandom](/reference/java/security/SecureRandom)` random) ` Initializes the key pair generator for a given modulus length (instead of parameters), and an optional SecureRandom bit source. |\n\nPublic methods\n--------------\n\n### initialize\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract void initialize (DSAParams params, \n SecureRandom random)\n```\n\nInitializes the key pair generator using the DSA family parameters\n(p,q and g) and an optional SecureRandom bit source. If a\nSecureRandom bit source is needed but not supplied, i.e. null, a\ndefault SecureRandom instance will be used.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------|\n| `params` | `DSAParams`: the parameters to use to generate the keys. \u003cbr /\u003e |\n| `random` | `SecureRandom`: the random bit source to use to generate key bits; can be null. \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------------------------------------------|---------------------------------------------------------|\n| [InvalidParameterException](/reference/java/security/InvalidParameterException) | if the `params` value is invalid, null, or unsupported. |\n\n### initialize\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract void initialize (int modlen, \n boolean genParams, \n SecureRandom random)\n```\n\nInitializes the key pair generator for a given modulus length\n(instead of parameters), and an optional SecureRandom bit source.\nIf a SecureRandom bit source is needed but not supplied, i.e.\nnull, a default SecureRandom instance will be used.\n\nIf `genParams` is true, this method generates new\np, q and g parameters. If it is false, the method uses precomputed\nparameters for the modulus length requested. If there are no\nprecomputed parameters for that modulus length, an exception will be\nthrown.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `modlen` | `int`: the modulus length in bits. Valid values are any multiple of 64 between 512 and 1024, inclusive, 2048, and 3072. \u003cbr /\u003e |\n| `genParams` | `boolean`: whether or not to generate new parameters for the modulus length requested. \u003cbr /\u003e |\n| `random` | `SecureRandom`: the random bit source to use to generate key bits; can be null. \u003cbr /\u003e |\n\n| Throws ||\n|---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|\n| [InvalidParameterException](/reference/java/security/InvalidParameterException) | if `modlen` is invalid, or unsupported, or if `genParams` is false and there are no precomputed parameters for the requested modulus length. |"]]
