Source for javax.crypto.interfaces.DHKey

   1: /* DHKey.java -- General interface for a Diffie-Hellman key.
   2:    Copyright (C) 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: 
  39: package javax.crypto.interfaces;
  40: 
  41: import javax.crypto.spec.DHParameterSpec;
  42: 
  43: /**
  44:  * This interface marks public/private keys in the Diffie-Hellman key
  45:  * exchange algorithm. Implementations of Diffie-Hellman keys should
  46:  * implement this interface, and applications can safely cast keys that
  47:  * are known to be Diffie-Hellman keys to this interface.
  48:  *
  49:  * @author Casey Marshall (csm@gnu.org)
  50:  * @since 1.4
  51:  */
  52: public interface DHKey
  53: {
  54:   /**
  55:    * Returns the Diffie-Hellman parameters for this key, which includes
  56:    * the generator and the prime.
  57:    *
  58:    * @return The Diffie-Hellman parameters.
  59:    */
  60:   DHParameterSpec getParams();
  61: }