Source for java.security.interfaces.DSAKeyPairGenerator

   1: /* DSAKeyPairGenerator.java -- Initialize a DSA key generator
   2:    Copyright (C) 1998, 2004 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.security.interfaces;
  39: 
  40: import java.security.InvalidParameterException;
  41: import java.security.SecureRandom;
  42: 
  43: /**
  44:  * This interface contains methods for intializing a Digital Signature
  45:  * Algorithm key generation engine.  The initialize methods may be called
  46:  * any number of times.  If no explicity initialization call is made, then
  47:  * the engine defaults to generating 1024-bit keys using pre-calculated
  48:  * base, prime, and subprime values.
  49:  *
  50:  * @version 0.0
  51:  *
  52:  * @author Aaron M. Renn (arenn@urbanophile.com)
  53:  */
  54: public interface DSAKeyPairGenerator
  55: {
  56:   /**
  57:    * Initializes the key generator with the specified DSA parameters and
  58:    * random bit source
  59:    *
  60:    * @param params The DSA parameters to use
  61:    * @param random The random bit source to use
  62:    *
  63:    * @exception InvalidParameterException If the parameters passed are not valid
  64:    */
  65:   void initialize (DSAParams params, SecureRandom random)
  66:     throws InvalidParameterException;
  67: 
  68:   /**
  69:    * Initializes the key generator to a give modulus.  If the <code>genParams</code>
  70:    * value is <code>true</code> then new base, prime, and subprime values
  71:    * will be generated for the given modulus.  If not, the pre-calculated
  72:    * values will be used.  If no pre-calculated values exist for the specified
  73:    * modulus, an exception will be thrown.  It is guaranteed that there will
  74:    * always be pre-calculated values for all modulus values between 512 and
  75:    * 1024 bits inclusives.
  76:    *
  77:    * @param modlen The modulus length
  78:    * @param genParams <code>true</code> to generate new DSA parameters, <code>false</code> otherwise
  79:    * @param random The random bit source to use
  80:    *
  81:    * @exception InvalidParameterException If a parameter is invalid
  82:    */
  83:   void initialize (int modlen, boolean genParams, SecureRandom random)
  84:     throws InvalidParameterException;
  85: }