001/* DSAKeyPairGenerator.java -- Initialize a DSA key generator
002   Copyright (C) 1998, 2004 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.security.interfaces;
039
040import java.security.InvalidParameterException;
041import java.security.SecureRandom;
042
043/**
044 * This interface contains methods for intializing a Digital Signature
045 * Algorithm key generation engine.  The initialize methods may be called
046 * any number of times.  If no explicity initialization call is made, then
047 * the engine defaults to generating 1024-bit keys using pre-calculated
048 * base, prime, and subprime values.
049 *
050 * @version 0.0
051 *
052 * @author Aaron M. Renn (arenn@urbanophile.com)
053 */
054public interface DSAKeyPairGenerator
055{
056  /**
057   * Initializes the key generator with the specified DSA parameters and
058   * random bit source
059   *
060   * @param params The DSA parameters to use
061   * @param random The random bit source to use
062   *
063   * @exception InvalidParameterException If the parameters passed are not valid
064   */
065  void initialize (DSAParams params, SecureRandom random)
066    throws InvalidParameterException;
067
068  /**
069   * Initializes the key generator to a give modulus.  If the <code>genParams</code>
070   * value is <code>true</code> then new base, prime, and subprime values
071   * will be generated for the given modulus.  If not, the pre-calculated
072   * values will be used.  If no pre-calculated values exist for the specified
073   * modulus, an exception will be thrown.  It is guaranteed that there will
074   * always be pre-calculated values for all modulus values between 512 and
075   * 1024 bits inclusives.
076   *
077   * @param modlen The modulus length
078   * @param genParams <code>true</code> to generate new DSA parameters, <code>false</code> otherwise
079   * @param random The random bit source to use
080   *
081   * @exception InvalidParameterException If a parameter is invalid
082   */
083  void initialize (int modlen, boolean genParams, SecureRandom random)
084    throws InvalidParameterException;
085}