001 /* X509KeyManager.java -- X.509 key manager interface.
002 Copyright (C) 2004 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.net.ssl;
040
041 import java.net.Socket;
042
043 import java.security.Principal;
044 import java.security.PrivateKey;
045 import java.security.cert.X509Certificate;
046
047 /**
048 * A key manager for X.509 certificates and their associated private keys.
049 */
050 public interface X509KeyManager extends KeyManager
051 {
052
053 /**
054 * Choose an alias for client-side authentication.
055 *
056 * @param keyTypes A list of acceptable key types.
057 * @param issuers A list of acceptable certificate issuers.
058 * @param socket The connecting socket.
059 * @return The chosen alias.
060 */
061 String chooseClientAlias(String[] keyTypes, Principal[] issuers,
062 Socket socket);
063
064 /**
065 * Choose an alias for server-side authentication.
066 *
067 * @param keyType The desired certificate type.
068 * @param issuers A list of acceptable certificate issuers.
069 * @param socket The connecting socket.
070 * @return The chosen alias.
071 */
072 String chooseServerAlias(String keyType, Principal[] issuers,
073 Socket socket);
074
075 /**
076 * Gets the X.509 certificate chain associated with the given alias.
077 *
078 * @param alias The alias.
079 * @return The certificate chain.
080 */
081 X509Certificate[] getCertificateChain(String alias);
082
083 /**
084 * Returns all client aliases that support the given key type.
085 *
086 * @param keyType The desired key type.
087 * @param issuers A list of acceptable certificate issuers.
088 * @return The (possibly empty) list of aliases.
089 */
090 String[] getClientAliases(String keyType, Principal[] issuers);
091
092 /**
093 * Gets the private key associated with the given alias.
094 *
095 * @param alias The alias.
096 * @return The private key.
097 */
098 PrivateKey getPrivateKey(String alias);
099
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 }