java.security.interfaces
Interface DSAKeyPairGenerator


public interface 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, the default is to generate 1024-bit keys, using precomputed p, q and g parameters and an instance of SecureRandom as the random bit source.

Users wishing to indicate DSA-specific parameters, and to generate a key pair suitable for use with the DSA algorithm typically

  1. Get a key pair generator for the DSA algorithm by calling the KeyPairGenerator getInstance method with "DSA" as its argument.

  2. Initialize the generator by casting the result to a DSAKeyPairGenerator and calling one of the initialize methods from this DSAKeyPairGenerator interface.

  3. Generate a key pair by calling the generateKeyPair method from the KeyPairGenerator class.

Note: it is not always necessary to do 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.

See Also:
KeyPairGenerator sample code for java.security.KeyPairGenerator definition code for java.security.KeyPairGenerator

Method Summary
 void initialize sample code for java.security.interfaces.DSAKeyPairGenerator.initialize(java.security.interfaces.DSAParams, java.security.SecureRandom) definition code for java.security.interfaces.DSAKeyPairGenerator.initialize(java.security.interfaces.DSAParams, java.security.SecureRandom) (DSAParams sample code for java.security.interfaces.DSAParams definition code for java.security.interfaces.DSAParams  params, SecureRandom sample code for java.security.SecureRandom definition code for java.security.SecureRandom  random)
          Initializes the key pair generator using p, q and g, the DSA family parameters.
 void initialize sample code for java.security.interfaces.DSAKeyPairGenerator.initialize(int, boolean, java.security.SecureRandom) definition code for java.security.interfaces.DSAKeyPairGenerator.initialize(int, boolean, java.security.SecureRandom) (int modlen, boolean genParams, SecureRandom sample code for java.security.SecureRandom definition code for java.security.SecureRandom  random)
          Initializes the key pair generator for a given modulus length, without parameters.
 

Method Detail

initialize sample code for java.security.interfaces.DSAKeyPairGenerator.initialize(java.security.interfaces.DSAParams, java.security.SecureRandom) definition code for java.security.interfaces.DSAKeyPairGenerator.initialize(java.security.interfaces.DSAParams, java.security.SecureRandom)

void initialize(DSAParams sample code for java.security.interfaces.DSAParams definition code for java.security.interfaces.DSAParams  params,
                SecureRandom sample code for java.security.SecureRandom definition code for java.security.SecureRandom  random)
                throws InvalidParameterException sample code for java.security.InvalidParameterException definition code for java.security.InvalidParameterException 
Initializes the key pair generator using p, q and g, the DSA family parameters.

Parameters:
params - the parameters to use to generate the keys.
random - the random bit source to use to generate key bits.
Throws:
InvalidParameterException sample code for java.security.InvalidParameterException definition code for java.security.InvalidParameterException - if the parameters passed are invalid or null.

initialize sample code for java.security.interfaces.DSAKeyPairGenerator.initialize(int, boolean, java.security.SecureRandom) definition code for java.security.interfaces.DSAKeyPairGenerator.initialize(int, boolean, java.security.SecureRandom)

void initialize(int modlen,
                boolean genParams,
                SecureRandom sample code for java.security.SecureRandom definition code for java.security.SecureRandom  random)
                throws InvalidParameterException sample code for java.security.InvalidParameterException definition code for java.security.InvalidParameterException 
Initializes the key pair generator for a given modulus length, without parameters.

If genParams is true, this method will generate new p, q and g parameters. If it is false, the method will use precomputed parameters for the modulus length requested. If there are no precomputed parameters for that modulus length, an exception will be thrown. It is guaranteed that there will always be default parameters for modulus lengths of 512 and 1024 bits.

Parameters:
modlen - the modulus length, in bits. Valid values are any multiple of 8 between 512 and 1024, inclusive.
random - the random bit source to use to generate key bits.
genParams - whether or not to generate new parameters for the modulus length requested.
Throws:
InvalidParameterException sample code for java.security.InvalidParameterException definition code for java.security.InvalidParameterException - if the modulus length is not between 512 and 1024, or if genParams is false and there are not precomputed parameters for the modulus length requested.