001    /* SslRMIClientSocketFactory.java -- 
002       Copyright (C) 2006 Free Software Foundation
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    package javax.rmi.ssl;
039    
040    import java.io.IOException;
041    import java.io.Serializable;
042    
043    import java.util.StringTokenizer;
044    import javax.net.ssl.SSLSocketFactory;
045    import javax.net.ssl.SSLSocket;
046    import java.net.Socket;
047    import java.rmi.server.RMIClientSocketFactory;
048    
049    /**
050     * SslRMIClientSocketFactory
051     *
052     * This class implements an RMIClientSocketFactory for SSL sockets.
053     * it uses the defeult 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     */
067    public 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        StringTokenizer st;
096        try
097          {
098            String o = (String)System.getProperty( p );
099            st = new StringTokenizer( o, "," );
100          }
101        catch(SecurityException se)
102          {
103            return null;
104          }
105    
106        int n = st.countTokens();
107        if( n < 1 )
108          return null;
109        String[] strs = new String[ n ];
110        for( int i = 0; i < n; i++ )
111          strs[i] = st.nextToken().trim();
112    
113        return strs;
114      }
115    
116      /**
117       * Creates an SSLSocket on a given port 
118       *
119       * @throws IOException if an error occurs on socket creation.
120       */
121      public Socket createSocket(String host, int port) throws IOException
122      {
123        SSLSocket socket = (SSLSocket)socketFactory.
124          createSocket( host, port );
125        if( enabledCipherSuites != null )
126          socket.setEnabledCipherSuites( enabledCipherSuites );
127        if( enabledProtocols != null )
128          socket.setEnabledProtocols( enabledProtocols );
129        return socket;
130      }
131    
132      /**
133       * Compare two SslRMIServerSocketFactor instances
134       */ 
135      public boolean equals(Object obj)
136      {
137        if( !(obj instanceof SslRMIClientSocketFactory) )
138          return false;
139        SslRMIClientSocketFactory s = (SslRMIClientSocketFactory)obj;
140        
141        if(!SslRMIServerSocketFactory.
142           cmpStrArray(enabledCipherSuites, s.enabledCipherSuites))
143          return false;
144    
145        if(!SslRMIServerSocketFactory.
146           cmpStrArray(enabledProtocols, s.enabledProtocols))
147          return false;
148    
149        return true;
150      }
151    
152      /**
153       * Returns the hash code of this object.
154       */
155      public int hashCode()
156      {
157        int hash = 0;
158        if( enabledCipherSuites != null )
159          for(int i = 0; i < enabledCipherSuites.length; i++ )
160            hash = hash ^ enabledCipherSuites[i].hashCode();
161        if( enabledProtocols != null )
162          for(int i = 0; i < enabledProtocols.length; i++ )
163            hash = hash ^ enabledProtocols[i].hashCode();
164        return hash;
165     }
166    }