/* DSAKeyPairGenerator.java -- Initialize a DSA key generator
   Copyright (C) 1998, 2004 Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

package java.security.interfaces;

import java.security.InvalidParameterException;
import java.security.SecureRandom;

/**
 * This interface contains methods for intializing a Digital Signature
 * Algorithm key generation engine.  The initialize methods may be called
 * any number of times.  If no explicity initialization call is made, then
 * the engine defaults to generating 1024-bit keys using pre-calculated
 * base, prime, and subprime values.
 *
 * @version 0.0
 *
 * @author Aaron M. Renn (arenn@urbanophile.com)
 */
public interface DSAKeyPairGenerator
{
  /**
   * Initializes the key generator with the specified DSA parameters and
   * random bit source
   *
   * @param params The DSA parameters to use
   * @param random The random bit source to use
   *
   * @exception InvalidParameterException If the parameters passed are not valid
   */
  void initialize (DSAParams params, SecureRandom random)
    throws InvalidParameterException;

  /**
   * Initializes the key generator to a give modulus.  If the <code>genParams</code>
   * value is <code>true</code> then new base, prime, and subprime values
   * will be generated for the given modulus.  If not, the pre-calculated
   * values will be used.  If no pre-calculated values exist for the specified
   * modulus, an exception will be thrown.  It is guaranteed that there will
   * always be pre-calculated values for all modulus values between 512 and
   * 1024 bits inclusives.
   *
   * @param modlen The modulus length
   * @param genParams <code>true</code> to generate new DSA parameters, <code>false</code> otherwise
   * @param random The random bit source to use
   *
   * @exception InvalidParameterException If a parameter is invalid
   */
  void initialize (int modlen, boolean genParams, SecureRandom random)
    throws InvalidParameterException;
}