001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017:
018: package org.apache.tomcat.util.net.jsse;
019:
020: import java.net.Socket;
021: import java.security.Principal;
022: import java.security.PrivateKey;
023: import java.security.cert.X509Certificate;
024: import javax.net.ssl.X509KeyManager;
025:
026: /**
027: * X509KeyManager which allows selection of a specific keypair and certificate
028: * chain (identified by their keystore alias name) to be used by the server to
029: * authenticate itself to SSL clients.
030: *
031: * @author Jan Luehe
032: */
033: public final class JSSEKeyManager implements X509KeyManager {
034:
035: private X509KeyManager delegate;
036: private String serverKeyAlias;
037:
038: /**
039: * Constructor.
040: *
041: * @param mgr The X509KeyManager used as a delegate
042: * @param serverKeyAlias The alias name of the server's keypair and
043: * supporting certificate chain
044: */
045: public JSSEKeyManager(X509KeyManager mgr, String serverKeyAlias) {
046: this .delegate = mgr;
047: this .serverKeyAlias = serverKeyAlias;
048: }
049:
050: /**
051: * Choose an alias to authenticate the client side of a secure socket,
052: * given the public key type and the list of certificate issuer authorities
053: * recognized by the peer (if any).
054: *
055: * @param keyType The key algorithm type name(s), ordered with the
056: * most-preferred key type first
057: * @param issuers The list of acceptable CA issuer subject names, or null
058: * if it does not matter which issuers are used
059: * @param socket The socket to be used for this connection. This parameter
060: * can be null, in which case this method will return the most generic
061: * alias to use
062: *
063: * @return The alias name for the desired key, or null if there are no
064: * matches
065: */
066: public String chooseClientAlias(String[] keyType,
067: Principal[] issuers, Socket socket) {
068: return delegate.chooseClientAlias(keyType, issuers, socket);
069: }
070:
071: /**
072: * Returns this key manager's server key alias that was provided in the
073: * constructor.
074: *
075: * @param keyType The key algorithm type name (ignored)
076: * @param issuers The list of acceptable CA issuer subject names, or null
077: * if it does not matter which issuers are used (ignored)
078: * @param socket The socket to be used for this connection. This parameter
079: * can be null, in which case this method will return the most generic
080: * alias to use (ignored)
081: *
082: * @return Alias name for the desired key
083: */
084: public String chooseServerAlias(String keyType,
085: Principal[] issuers, Socket socket) {
086: return serverKeyAlias;
087: }
088:
089: /**
090: * Returns the certificate chain associated with the given alias.
091: *
092: * @param alias The alias name
093: *
094: * @return Certificate chain (ordered with the user's certificate first
095: * and the root certificate authority last), or null if the alias can't be
096: * found
097: */
098: public X509Certificate[] getCertificateChain(String alias) {
099: return delegate.getCertificateChain(alias);
100: }
101:
102: /**
103: * Get the matching aliases for authenticating the client side of a secure
104: * socket, given the public key type and the list of certificate issuer
105: * authorities recognized by the peer (if any).
106: *
107: * @param keyType The key algorithm type name
108: * @param issuers The list of acceptable CA issuer subject names, or null
109: * if it does not matter which issuers are used
110: *
111: * @return Array of the matching alias names, or null if there were no
112: * matches
113: */
114: public String[] getClientAliases(String keyType, Principal[] issuers) {
115: return delegate.getClientAliases(keyType, issuers);
116: }
117:
118: /**
119: * Get the matching aliases for authenticating the server side of a secure
120: * socket, given the public key type and the list of certificate issuer
121: * authorities recognized by the peer (if any).
122: *
123: * @param keyType The key algorithm type name
124: * @param issuers The list of acceptable CA issuer subject names, or null
125: * if it does not matter which issuers are used
126: *
127: * @return Array of the matching alias names, or null if there were no
128: * matches
129: */
130: public String[] getServerAliases(String keyType, Principal[] issuers) {
131: return delegate.getServerAliases(keyType, issuers);
132: }
133:
134: /**
135: * Returns the key associated with the given alias.
136: *
137: * @param alias The alias name
138: *
139: * @return The requested key, or null if the alias can't be found
140: */
141: public PrivateKey getPrivateKey(String alias) {
142: return delegate.getPrivateKey(alias);
143: }
144: }
|