Source for javax.net.ssl.X509KeyManager

   1: /* X509KeyManager.java -- X.509 key manager interface.
   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.net.ssl;
  40: 
  41: import java.net.Socket;
  42: 
  43: import java.security.Principal;
  44: import java.security.PrivateKey;
  45: import java.security.cert.X509Certificate;
  46: 
  47: /**
  48:  * A key manager for X.509 certificates and their associated private keys.
  49:  */
  50: public interface X509KeyManager extends KeyManager
  51: {
  52: 
  53:   /**
  54:    * Choose an alias for client-side authentication.
  55:    *
  56:    * @param keyTypes A list of acceptable key types.
  57:    * @param issuers A list of acceptable certificate issuers.
  58:    * @param socket The connecting socket.
  59:    * @return The chosen alias.
  60:    */
  61:   String chooseClientAlias(String[] keyTypes, Principal[] issuers,
  62:                            Socket socket);
  63: 
  64:   /**
  65:    * Choose an alias for server-side authentication.
  66:    *
  67:    * @param keyType The desired certificate type.
  68:    * @param issuers A list of acceptable certificate issuers.
  69:    * @param socket The connecting socket.
  70:    * @return The chosen alias.
  71:    */
  72:   String chooseServerAlias(String keyType, Principal[] issuers,
  73:                            Socket socket);
  74: 
  75:   /**
  76:    * Gets the X.509 certificate chain associated with the given alias.
  77:    *
  78:    * @param alias The alias.
  79:    * @return The certificate chain.
  80:    */
  81:   X509Certificate[] getCertificateChain(String alias);
  82: 
  83:   /**
  84:    * Returns all client aliases that support the given key type.
  85:    *
  86:    * @param keyType The desired key type.
  87:    * @param issuers A list of acceptable certificate issuers.
  88:    * @return The (possibly empty) list of aliases.
  89:    */
  90:   String[] getClientAliases(String keyType, Principal[] issuers);
  91: 
  92:   /**
  93:    * Gets the private key associated with the given alias.
  94:    *
  95:    * @param alias The alias.
  96:    * @return The private key.
  97:    */
  98:   PrivateKey getPrivateKey(String alias);
  99: 
 100:   /**
 101:    * Returns all server aliases that support the given key type.
 102:    *
 103:    * @param keyType The desired key type.
 104:    * @param issuers A list of acceptable certificate issuers.
 105:    * @return The (possibly empty) list of aliases.
 106:    */
 107:   String[] getServerAliases(String keyType, Principal[] issuers);
 108: }