001/* SslRMIClientSocketFactory.java -- 
002   Copyright (C) 2006 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package javax.rmi.ssl;
039
040import java.io.IOException;
041import java.io.Serializable;
042
043import java.util.StringTokenizer;
044import javax.net.ssl.SSLSocketFactory;
045import javax.net.ssl.SSLSocket;
046import java.net.Socket;
047import java.rmi.server.RMIClientSocketFactory;
048
049/**
050 * SslRMIClientSocketFactory
051 *
052 * This class implements an RMIClientSocketFactory for SSL sockets.
053 * it uses the default SSLClientSocketFactory.
054 *
055 * This class can optionally use the following system properties, if set: 
056 * <code>javax.rmi.ssl.client.enabledCipherSuites</code>
057 * <code>javax.rmi.ssl.client.enabledProtocols</code>
058 *
059 * These properties will specify a list of SSL/TLS cipher suites and protocols,
060 * respectively, to enable on the created sockets. 
061 *
062 * Both properties should consist of a comma-separated list.
063 *
064 * @author Sven de Marothy
065 * @since 1.5
066 */
067public class SslRMIClientSocketFactory 
068  implements RMIClientSocketFactory, Serializable
069{
070
071  /**
072   * Compatible with JDK 1.5
073   */
074  private static final long serialVersionUID = -8310631444933958385L;
075
076  private String[] enabledCipherSuites, enabledProtocols;
077
078  /**
079   * The SSL Socket factory.
080   */
081  private static SSLSocketFactory socketFactory = 
082    (SSLSocketFactory)SSLSocketFactory.getDefault();
083
084  /**
085   * Creates a new SslRMIClientSocketFactory 
086   */
087  public SslRMIClientSocketFactory()
088  {
089    enabledCipherSuites = getProp("javax.rmi.ssl.client.enabledCipherSuites");
090    enabledProtocols = getProp("javax.rmi.ssl.client.enabledProtocols");
091  }
092
093  private String[] getProp(String p)
094  {
095    String o;
096    try
097      {
098        o = System.getProperty(p);
099      }
100    catch(SecurityException se)
101      {
102        return null;
103      }
104
105    if (o == null)
106      return null;
107    StringTokenizer st = new StringTokenizer( o, "," );
108    int n = st.countTokens();
109    if( n < 1 )
110      return null;
111    String[] strs = new String[ n ];
112    for( int i = 0; i < n; i++ )
113      strs[i] = st.nextToken().trim();
114
115    return strs;
116  }
117
118  /**
119   * Creates an SSLSocket on a given port 
120   *
121   * @throws IOException if an error occurs on socket creation.
122   */
123  public Socket createSocket(String host, int port) throws IOException
124  {
125    SSLSocket socket = (SSLSocket)socketFactory.
126      createSocket( host, port );
127    if( enabledCipherSuites != null )
128      socket.setEnabledCipherSuites( enabledCipherSuites );
129    if( enabledProtocols != null )
130      socket.setEnabledProtocols( enabledProtocols );
131    return socket;
132  }
133
134  /**
135   * Compare two SslRMIServerSocketFactor instances
136   */ 
137  public boolean equals(Object obj)
138  {
139    if( !(obj instanceof SslRMIClientSocketFactory) )
140      return false;
141    SslRMIClientSocketFactory s = (SslRMIClientSocketFactory)obj;
142    
143    if(!SslRMIServerSocketFactory.
144       cmpStrArray(enabledCipherSuites, s.enabledCipherSuites))
145      return false;
146
147    if(!SslRMIServerSocketFactory.
148       cmpStrArray(enabledProtocols, s.enabledProtocols))
149      return false;
150
151    return true;
152  }
153
154  /**
155   * Returns the hash code of this object.
156   */
157  public int hashCode()
158  {
159    int hash = 0;
160    if( enabledCipherSuites != null )
161      for(int i = 0; i < enabledCipherSuites.length; i++ )
162        hash = hash ^ enabledCipherSuites[i].hashCode();
163    if( enabledProtocols != null )
164      for(int i = 0; i < enabledProtocols.length; i++ )
165        hash = hash ^ enabledProtocols[i].hashCode();
166    return hash;
167 }
168}