Source for javax.rmi.ssl.SslRMIClientSocketFactory

   1: /* SslRMIClientSocketFactory.java -- 
   2:    Copyright (C) 2006 Free Software Foundation
   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: package javax.rmi.ssl;
  39: 
  40: import java.io.IOException;
  41: import java.io.Serializable;
  42: 
  43: import java.util.StringTokenizer;
  44: import javax.net.ssl.SSLSocketFactory;
  45: import javax.net.ssl.SSLSocket;
  46: import java.net.Socket;
  47: import java.rmi.server.RMIClientSocketFactory;
  48: 
  49: /**
  50:  * SslRMIClientSocketFactory
  51:  *
  52:  * This class implements an RMIClientSocketFactory for SSL sockets.
  53:  * it uses the defeult SSLClientSocketFactory.
  54:  *
  55:  * This class can optionally use the following system properties, if set: 
  56:  * <code>javax.rmi.ssl.client.enabledCipherSuites</code>
  57:  * <code>javax.rmi.ssl.client.enabledProtocols</code>
  58:  *
  59:  * These properties will specify a list of SSL/TLS cipher suites and protocols,
  60:  * respectively, to enable on the created sockets. 
  61:  *
  62:  * Both properties should consist of a comma-separated list.
  63:  *
  64:  * @author Sven de Marothy
  65:  * @since 1.5
  66:  */
  67: public class SslRMIClientSocketFactory 
  68:   implements RMIClientSocketFactory, Serializable
  69: {
  70: 
  71:   /**
  72:    * Compatible with JDK 1.5
  73:    */
  74:   private static final long serialVersionUID = -8310631444933958385L;
  75: 
  76:   private String[] enabledCipherSuites, enabledProtocols;
  77: 
  78:   /**
  79:    * The SSL Socket factory.
  80:    */
  81:   private static SSLSocketFactory socketFactory = 
  82:     (SSLSocketFactory)SSLSocketFactory.getDefault();
  83: 
  84:   /**
  85:    * Creates a new SslRMIClientSocketFactory 
  86:    */
  87:   public SslRMIClientSocketFactory()
  88:   {
  89:     enabledCipherSuites = getProp("javax.rmi.ssl.client.enabledCipherSuites");
  90:     enabledProtocols = getProp("javax.rmi.ssl.client.enabledProtocols");
  91:   }
  92: 
  93:   private String[] getProp(String p)
  94:   {
  95:     StringTokenizer st;
  96:     try
  97:       {
  98:     String o = (String)System.getProperty( p );
  99:     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: }