Source for gnu.javax.net.ssl.SRPTrustManager

   1: /* SRPTrustManager.java -- interface to SRP trust managers.
   2:    Copyright (C) 2006  Free Software Foundation, Inc.
   3: 
   4: This file is a 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 of the License, or (at
   9: your option) 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; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: 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 gnu.javax.net.ssl;
  40: 
  41: import gnu.javax.crypto.sasl.srp.PasswordFile;
  42: 
  43: import java.math.BigInteger;
  44: import java.security.KeyPair;
  45: import javax.net.ssl.TrustManager;
  46: 
  47: /**
  48:  * A trust manager for secure remote password (SRP) key exchange cipher
  49:  * suites. This is a read-only interface to the {@link
  50:  * gnu.crypto.sasl.srp.PasswordFile} class, with convenience methods to
  51:  * generate session key pairs.
  52:  */
  53: public interface SRPTrustManager extends TrustManager
  54: {
  55: 
  56:   // Methods.
  57:   // -------------------------------------------------------------------------
  58: 
  59:   /**
  60:    * Tests if the configured password file contains the specified user name.
  61:    *
  62:    * @param user The user name.
  63:    * @return True if the password file has an entry for <i>user</i>
  64:    */
  65:   boolean contains(String user);
  66: 
  67:   /**
  68:    * Create and return a session SRP key pair for the given user name.
  69:    *
  70:    * @param user The user name to generate the key pair for.
  71:    * @return The session key pair, or <code>null</code> if there is no
  72:    *   entry for <i>user</i>.
  73:    */
  74:   KeyPair getKeyPair(String user);
  75: 
  76:   /**
  77:    * Returns the salt value for the given user.
  78:    *
  79:    * @param user The user name.
  80:    * @return The salt for <i>user</i>'s entry, or <code>null</code>.
  81:    */
  82:   byte[] getSalt(String user);
  83: 
  84:   /**
  85:    * Returns the password verifier for the given user.
  86:    *
  87:    * @param user The user name.
  88:    * @return <i>user</i>'s password verifier, or <code>null</code>.
  89:    */
  90:   BigInteger getVerifier(String user);
  91: 
  92:   /**
  93:    * Returns a reference to the SRP {@link PasswordFile} used by this
  94:    * {@link TrustManager}.
  95:    *
  96:    * @return a reference to the SRP password file in use.
  97:    */
  98:   PasswordFile getPasswordFile();
  99: }