com.entrust.toolkit.smproxy

Class SMProxySSLSocketWrapper

java.lang.Object

java.net.Socket

javax.net.ssl.SSLSocket

com.entrust.toolkit.smproxy.SMProxySSLSocketWrapper

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public final class SMProxySSLSocketWrapper
extends javax.net.ssl.SSLSocket

The purpose of this class is to wrap a standard SSLSocket so that the unconnected Socket can be configured with hostname verification information when a call to connect() is made.

This class is never meant to be used by a toolkit application

Since:

8.1

Constructor Summary

Constructors

Constructor and Description
SMProxySSLSocketWrapper(javax.net.ssl.SSLSocket socket, SMProxyWrapper wrapper) Wrap a socket which is the parameter for this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)
void	bind(java.net.SocketAddress bindpoint)
void	close()
void	connect(java.net.SocketAddress endpoint) Make a connection to an unconnected socket at the specified endpoint.
void	connect(java.net.SocketAddress endpoint, int timeout) Make a connection to an unconnected socket at the specified endpoint with the given timeout value.
java.nio.channels.SocketChannel	getChannel()
java.lang.String[]	getEnabledCipherSuites()
java.lang.String[]	getEnabledProtocols()
boolean	getEnableSessionCreation()
java.net.InetAddress	getInetAddress()
SMProxySSLSocketFactory.InetHandling	getInetAddressHandling() Return how the socket should be configured when created with an InetAddress
java.io.InputStream	getInputStream()
boolean	getKeepAlive()
java.net.InetAddress	getLocalAddress()
int	getLocalPort()
java.net.SocketAddress	getLocalSocketAddress()
boolean	getNeedClientAuth()
boolean	getOOBInline()
java.io.OutputStream	getOutputStream() Overide the default OutputStream with the SMProxyOutputStream
int	getPort()
int	getReceiveBufferSize()
java.net.SocketAddress	getRemoteSocketAddress()
boolean	getReuseAddress()
int	getSendBufferSize()
javax.net.ssl.SSLSession	getSession()
int	getSoLinger()
int	getSoTimeout()
java.lang.String[]	getSupportedCipherSuites()
java.lang.String[]	getSupportedProtocols()
boolean	getTcpNoDelay()
int	getTrafficClass()
boolean	getUseClientMode()
boolean	getWantClientAuth()
boolean	isBound()
boolean	isClosed()
boolean	isConnected()
boolean	isInputShutdown()
boolean	isOutputShutdown()
void	removeHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)
void	sendUrgentData(int data)
void	setEnabledCipherSuites(java.lang.String[] suites)
void	setEnabledProtocols(java.lang.String[] protocols)
void	setEnableSessionCreation(boolean flag)
void	setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier)
void	setInetAddressHandling(SMProxySSLSocketFactory.InetHandling handling) This API allows the socket to be configured with how a Socket created with the InetAddress class should be handled.
void	setKeepAlive(boolean on)
void	setNeedClientAuth(boolean need)
void	setOOBInline(boolean on)
void	setPerformancePreferences(int connectionTime, int latency, int bandwidth)
void	setReceiveBufferSize(int size)
void	setReuseAddress(boolean on)
void	setSendBufferSize(int size)
void	setSoLinger(boolean on, int l)
void	setSoTimeout(int timeout)
void	setTcpNoDelay(boolean on)
void	setTrafficClass(int tc)
void	setUseClientMode(boolean mode)
void	setWantClientAuth(boolean want)
void	shutdownInput()
void	shutdownOutput()
void	startHandshake()
java.lang.String	toString()

Methods inherited from class javax.net.ssl.SSLSocket

getHandshakeSession, getSSLParameters, setSSLParameters

Methods inherited from class java.net.Socket

setSocketImplFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SMProxySSLSocketWrapper

public SMProxySSLSocketWrapper(javax.net.ssl.SSLSocket socket,
                       SMProxyWrapper wrapper)

Wrap a socket which is the parameter for this class.

Parameters:

socket - the socket to wrap

wrapper - the wrapper

Throws:

SMProxyException - if either or the parameters is null

Method Detail

addHandshakeCompletedListener

public void addHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)

Specified by:

addHandshakeCompletedListener in class javax.net.ssl.SSLSocket

getEnableSessionCreation

public boolean getEnableSessionCreation()

Specified by:

getEnableSessionCreation in class javax.net.ssl.SSLSocket

getEnabledCipherSuites

public java.lang.String[] getEnabledCipherSuites()

Specified by:

getEnabledCipherSuites in class javax.net.ssl.SSLSocket

getEnabledProtocols

public java.lang.String[] getEnabledProtocols()

Specified by:

getEnabledProtocols in class javax.net.ssl.SSLSocket

getNeedClientAuth

public boolean getNeedClientAuth()

Specified by:

getNeedClientAuth in class javax.net.ssl.SSLSocket

getSession

public javax.net.ssl.SSLSession getSession()

Specified by:

getSession in class javax.net.ssl.SSLSocket

getSupportedCipherSuites

public java.lang.String[] getSupportedCipherSuites()

Specified by:

getSupportedCipherSuites in class javax.net.ssl.SSLSocket

getSupportedProtocols

public java.lang.String[] getSupportedProtocols()

Specified by:

getSupportedProtocols in class javax.net.ssl.SSLSocket

getUseClientMode

public boolean getUseClientMode()

Specified by:

getUseClientMode in class javax.net.ssl.SSLSocket

getWantClientAuth

public boolean getWantClientAuth()

Specified by:

getWantClientAuth in class javax.net.ssl.SSLSocket

removeHandshakeCompletedListener

public void removeHandshakeCompletedListener(javax.net.ssl.HandshakeCompletedListener listener)

Specified by:

removeHandshakeCompletedListener in class javax.net.ssl.SSLSocket

setEnableSessionCreation

public void setEnableSessionCreation(boolean flag)

Specified by:

setEnableSessionCreation in class javax.net.ssl.SSLSocket

setEnabledCipherSuites

public void setEnabledCipherSuites(java.lang.String[] suites)

Specified by:

setEnabledCipherSuites in class javax.net.ssl.SSLSocket

setEnabledProtocols

public void setEnabledProtocols(java.lang.String[] protocols)

Specified by:

setEnabledProtocols in class javax.net.ssl.SSLSocket

setNeedClientAuth

public void setNeedClientAuth(boolean need)

Specified by:

setNeedClientAuth in class javax.net.ssl.SSLSocket

setUseClientMode

public void setUseClientMode(boolean mode)

Specified by:

setUseClientMode in class javax.net.ssl.SSLSocket

setWantClientAuth

public void setWantClientAuth(boolean want)

Specified by:

setWantClientAuth in class javax.net.ssl.SSLSocket

startHandshake

public void startHandshake()
                    throws java.io.IOException

Specified by:

startHandshake in class javax.net.ssl.SSLSocket

Throws:

java.io.IOException

setInetAddressHandling

public void setInetAddressHandling(SMProxySSLSocketFactory.InetHandling handling)

This API allows the socket to be configured with how a Socket created with the InetAddress class should be handled. InetHandling is an enumerated type defined as follows:

public enum InetHandling {HOSTNAME, IPADDRESS, REJECT}

• HOSTNAME - An InetAddress will be created with a hostname
• IPADDRESS - The InetAddress will be created with an IP Address
• REJECT - The default setting, -throws an exception if sockets are created with an InetAddress
• COMPAT - Compatible with previous versions of the toolkit. Uses Session.getPeerHost to lookup the hostname

Note, if the HOSTNAME or IPADDRESS setting is used, it will be up to the client application to enforce that InetAddress objects are created with that type of object. Failure to do so may result in a DNS lookup which makes the implementation vulnerable to DNS attacks.

Note: Using a hostname to create the socket is always safe.

Parameters:

handling - enumerated type.

Since:

8.1

getInetAddressHandling

public SMProxySSLSocketFactory.InetHandling getInetAddressHandling()
                                                            throws java.io.IOException

Return how the socket should be configured when created with an InetAddress

Returns:

an InetHandling enumerate type, which will contain one of the following values:

 REJECT which will throw an exception
 HOSTNAME which will assume InetAddress is created with a hostname
 IPADDRESS which will assume InetAddress is created with an IP
 COMPAT - Compatible with previous versions of the toolkit.  Uses Session.getPeerHost
          to lookup the hostname
 

Throws:

java.io.IOException

Since:

8.1

connect

public void connect(java.net.SocketAddress endpoint,
           int timeout)
             throws java.io.IOException

Make a connection to an unconnected socket at the specified endpoint with the given timeout value. This is the method we need to check hostname verification once the socket is connected.

Overrides:

connect in class java.net.Socket

Throws:

java.io.IOException

connect

public void connect(java.net.SocketAddress endpoint)
             throws java.io.IOException

Make a connection to an unconnected socket at the specified endpoint. A timeout value of 0 will be used and indicates no timeout limit.

Overrides:

connect in class java.net.Socket

Throws:

java.io.IOException

setHostnameVerifier

public void setHostnameVerifier(javax.net.ssl.HostnameVerifier verifier)

getChannel

public java.nio.channels.SocketChannel getChannel()

Overrides:

getChannel in class java.net.Socket

getInetAddress

public java.net.InetAddress getInetAddress()

Overrides:

getInetAddress in class java.net.Socket

getKeepAlive

public boolean getKeepAlive()
                     throws java.net.SocketException

Overrides:

getKeepAlive in class java.net.Socket

Throws:

java.net.SocketException

getLocalAddress

public java.net.InetAddress getLocalAddress()

Overrides:

getLocalAddress in class java.net.Socket

getLocalPort

public int getLocalPort()

Overrides:

getLocalPort in class java.net.Socket

getLocalSocketAddress

public java.net.SocketAddress getLocalSocketAddress()

Overrides:

getLocalSocketAddress in class java.net.Socket

getOOBInline

public boolean getOOBInline()
                     throws java.net.SocketException

Overrides:

getOOBInline in class java.net.Socket

Throws:

java.net.SocketException

getPort

public int getPort()

Overrides:

getPort in class java.net.Socket

getReceiveBufferSize

public int getReceiveBufferSize()
                         throws java.net.SocketException

Overrides:

getReceiveBufferSize in class java.net.Socket

Throws:

java.net.SocketException

getRemoteSocketAddress

public java.net.SocketAddress getRemoteSocketAddress()

Overrides:

getRemoteSocketAddress in class java.net.Socket

getReuseAddress

public boolean getReuseAddress()
                        throws java.net.SocketException

Overrides:

getReuseAddress in class java.net.Socket

Throws:

java.net.SocketException

getSendBufferSize

public int getSendBufferSize()
                      throws java.net.SocketException

Overrides:

getSendBufferSize in class java.net.Socket

Throws:

java.net.SocketException

getSoLinger

public int getSoLinger()
                throws java.net.SocketException

Overrides:

getSoLinger in class java.net.Socket

Throws:

java.net.SocketException

getSoTimeout

public int getSoTimeout()
                 throws java.net.SocketException

Overrides:

getSoTimeout in class java.net.Socket

Throws:

java.net.SocketException

getTcpNoDelay

public boolean getTcpNoDelay()
                      throws java.net.SocketException

Overrides:

getTcpNoDelay in class java.net.Socket

Throws:

java.net.SocketException

getTrafficClass

public int getTrafficClass()
                    throws java.net.SocketException

Overrides:

getTrafficClass in class java.net.Socket

Throws:

java.net.SocketException

isBound

public boolean isBound()

Overrides:

isBound in class java.net.Socket

isClosed

public boolean isClosed()

Overrides:

isClosed in class java.net.Socket

isConnected

public boolean isConnected()

Overrides:

isConnected in class java.net.Socket

isInputShutdown

public boolean isInputShutdown()

Overrides:

isInputShutdown in class java.net.Socket

isOutputShutdown

public boolean isOutputShutdown()

Overrides:

isOutputShutdown in class java.net.Socket

sendUrgentData

public void sendUrgentData(int data)
                    throws java.io.IOException

Overrides:

sendUrgentData in class java.net.Socket

Throws:

java.io.IOException

setKeepAlive

public void setKeepAlive(boolean on)
                  throws java.net.SocketException

Overrides:

setKeepAlive in class java.net.Socket

Throws:

java.net.SocketException

setOOBInline

public void setOOBInline(boolean on)
                  throws java.net.SocketException

Overrides:

setOOBInline in class java.net.Socket

Throws:

java.net.SocketException

setReceiveBufferSize

public void setReceiveBufferSize(int size)
                          throws java.net.SocketException

Overrides:

setReceiveBufferSize in class java.net.Socket

Throws:

java.net.SocketException

setReuseAddress

public void setReuseAddress(boolean on)
                     throws java.net.SocketException

Overrides:

setReuseAddress in class java.net.Socket

Throws:

java.net.SocketException

setSendBufferSize

public void setSendBufferSize(int size)
                       throws java.net.SocketException

Overrides:

setSendBufferSize in class java.net.Socket

Throws:

java.net.SocketException

setSoLinger

public void setSoLinger(boolean on,
               int l)
                 throws java.net.SocketException

Overrides:

setSoLinger in class java.net.Socket

Throws:

java.net.SocketException

setSoTimeout

public void setSoTimeout(int timeout)
                  throws java.net.SocketException

Overrides:

setSoTimeout in class java.net.Socket

Throws:

java.net.SocketException

setTcpNoDelay

public void setTcpNoDelay(boolean on)
                   throws java.net.SocketException

Overrides:

setTcpNoDelay in class java.net.Socket

Throws:

java.net.SocketException

setTrafficClass

public void setTrafficClass(int tc)
                     throws java.net.SocketException

Overrides:

setTrafficClass in class java.net.Socket

Throws:

java.net.SocketException

shutdownInput

public void shutdownInput()
                   throws java.io.IOException

Overrides:

shutdownInput in class java.net.Socket

Throws:

java.io.IOException

shutdownOutput

public void shutdownOutput()
                    throws java.io.IOException

Overrides:

shutdownOutput in class java.net.Socket

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.net.Socket

setPerformancePreferences

public void setPerformancePreferences(int connectionTime,
                             int latency,
                             int bandwidth)

Overrides:

setPerformancePreferences in class java.net.Socket

bind

public void bind(java.net.SocketAddress bindpoint)
          throws java.io.IOException

Overrides:

bind in class java.net.Socket

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.net.Socket

Throws:

java.io.IOException

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Overrides:

getInputStream in class java.net.Socket

Throws:

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Overide the default OutputStream with the SMProxyOutputStream

Overrides:

getOutputStream in class java.net.Socket

Throws:

java.io.IOException