org.apache.http.conn.ssl
Class SSLSocketFactory

java.lang.Object
  extended by org.apache.http.conn.ssl.SSLSocketFactory
All Implemented Interfaces:
LayeredSocketFactory, SocketFactory

public class SSLSocketFactory
extends java.lang.Object
implements LayeredSocketFactory

Layered socket factory for TLS/SSL connections, based on JSSE. .

SSLSocketFactory can be used to validate the identity of the HTTPS server against a list of trusted certificates and to authenticate to the HTTPS server using a private key.

SSLSocketFactory will enable server authentication when supplied with a truststore file containg one or several trusted certificates. The client secure socket will reject the connection during the SSL session handshake if the target HTTPS server attempts to authenticate itself with a non-trusted certificate.

Use JDK keytool utility to import a trusted certificate and generate a truststore file:

     keytool -import -alias "my server cert" -file server.crt -keystore my.truststore
    

SSLSocketFactory will enable client authentication when supplied with a keystore file containg a private key/public certificate pair. The client secure socket will use the private key to authenticate itself to the target HTTPS server during the SSL session handshake if requested to do so by the server. The target HTTPS server will in its turn verify the certificate presented by the client in order to establish client's authenticity

Use the following sequence of actions to generate a keystore file

Author:
Oleg Kalnichevski, Julius Davies

Field Summary
static X509HostnameVerifier ALLOW_ALL_HOSTNAME_VERIFIER
           
static X509HostnameVerifier BROWSER_COMPATIBLE_HOSTNAME_VERIFIER
           
static java.lang.String SSL
           
static java.lang.String SSLV2
           
static X509HostnameVerifier STRICT_HOSTNAME_VERIFIER
           
static java.lang.String TLS
           
 
Constructor Summary
SSLSocketFactory(java.security.KeyStore truststore)
           
SSLSocketFactory(java.security.KeyStore keystore, java.lang.String keystorePassword)
           
SSLSocketFactory(java.security.KeyStore keystore, java.lang.String keystorePassword, java.security.KeyStore truststore)
           
SSLSocketFactory(javax.net.ssl.SSLContext sslContext)
           
SSLSocketFactory(javax.net.ssl.SSLContext sslContext, HostNameResolver nameResolver)
           
SSLSocketFactory(java.lang.String algorithm, java.security.KeyStore keystore, java.lang.String keystorePassword, java.security.KeyStore truststore, java.security.SecureRandom random, HostNameResolver nameResolver)
           
 
Method Summary
 java.net.Socket connectSocket(java.net.Socket sock, java.lang.String host, int port, java.net.InetAddress localAddress, int localPort, org.apache.http.params.HttpParams params)
          Connects a socket to the given host.
 java.net.Socket createSocket()
          Creates a new, unconnected socket.
 java.net.Socket createSocket(java.net.Socket socket, java.lang.String host, int port, boolean autoClose)
          Returns a socket connected to the given host that is layered over an existing socket.
 X509HostnameVerifier getHostnameVerifier()
           
static SSLSocketFactory getSocketFactory()
          Gets the default factory, which uses the default JVM settings for secure connections.
 boolean isSecure(java.net.Socket sock)
          Checks whether a socket connection is secure.
 void setHostnameVerifier(X509HostnameVerifier hostnameVerifier)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TLS

public static final java.lang.String TLS
See Also:
Constant Field Values

SSL

public static final java.lang.String SSL
See Also:
Constant Field Values

SSLV2

public static final java.lang.String SSLV2
See Also:
Constant Field Values

ALLOW_ALL_HOSTNAME_VERIFIER

public static final X509HostnameVerifier ALLOW_ALL_HOSTNAME_VERIFIER

BROWSER_COMPATIBLE_HOSTNAME_VERIFIER

public static final X509HostnameVerifier BROWSER_COMPATIBLE_HOSTNAME_VERIFIER

STRICT_HOSTNAME_VERIFIER

public static final X509HostnameVerifier STRICT_HOSTNAME_VERIFIER
Constructor Detail

SSLSocketFactory

public SSLSocketFactory(java.lang.String algorithm,
                        java.security.KeyStore keystore,
                        java.lang.String keystorePassword,
                        java.security.KeyStore truststore,
                        java.security.SecureRandom random,
                        HostNameResolver nameResolver)
                 throws java.security.NoSuchAlgorithmException,
                        java.security.KeyManagementException,
                        java.security.KeyStoreException,
                        java.security.UnrecoverableKeyException
Throws:
java.security.NoSuchAlgorithmException
java.security.KeyManagementException
java.security.KeyStoreException
java.security.UnrecoverableKeyException

SSLSocketFactory

public SSLSocketFactory(java.security.KeyStore keystore,
                        java.lang.String keystorePassword,
                        java.security.KeyStore truststore)
                 throws java.security.NoSuchAlgorithmException,
                        java.security.KeyManagementException,
                        java.security.KeyStoreException,
                        java.security.UnrecoverableKeyException
Throws:
java.security.NoSuchAlgorithmException
java.security.KeyManagementException
java.security.KeyStoreException
java.security.UnrecoverableKeyException

SSLSocketFactory

public SSLSocketFactory(java.security.KeyStore keystore,
                        java.lang.String keystorePassword)
                 throws java.security.NoSuchAlgorithmException,
                        java.security.KeyManagementException,
                        java.security.KeyStoreException,
                        java.security.UnrecoverableKeyException
Throws:
java.security.NoSuchAlgorithmException
java.security.KeyManagementException
java.security.KeyStoreException
java.security.UnrecoverableKeyException

SSLSocketFactory

public SSLSocketFactory(java.security.KeyStore truststore)
                 throws java.security.NoSuchAlgorithmException,
                        java.security.KeyManagementException,
                        java.security.KeyStoreException,
                        java.security.UnrecoverableKeyException
Throws:
java.security.NoSuchAlgorithmException
java.security.KeyManagementException
java.security.KeyStoreException
java.security.UnrecoverableKeyException

SSLSocketFactory

public SSLSocketFactory(javax.net.ssl.SSLContext sslContext,
                        HostNameResolver nameResolver)

SSLSocketFactory

public SSLSocketFactory(javax.net.ssl.SSLContext sslContext)
Method Detail

getSocketFactory

public static SSLSocketFactory getSocketFactory()
Gets the default factory, which uses the default JVM settings for secure connections.

Returns:
the default factory

createSocket

public java.net.Socket createSocket()
                             throws java.io.IOException
Description copied from interface: SocketFactory
Creates a new, unconnected socket. The socket should subsequently be passed to connectSocket.

Specified by:
createSocket in interface SocketFactory
Returns:
a new socket
Throws:
java.io.IOException - if an I/O error occurs while creating the socket

connectSocket

public java.net.Socket connectSocket(java.net.Socket sock,
                                     java.lang.String host,
                                     int port,
                                     java.net.InetAddress localAddress,
                                     int localPort,
                                     org.apache.http.params.HttpParams params)
                              throws java.io.IOException
Description copied from interface: SocketFactory
Connects a socket to the given host.

Specified by:
connectSocket in interface SocketFactory
Parameters:
sock - the socket to connect, as obtained from createSocket. null indicates that a new socket should be created and connected.
host - the host to connect to
port - the port to connect to on the host
localAddress - the local address to bind the socket to, or null for any
localPort - the port on the local machine, 0 or a negative number for any
params - additional parameters for connecting
Returns:
the connected socket. The returned object may be different from the sock argument if this factory supports a layered protocol.
Throws:
java.io.IOException - if an I/O error occurs
java.net.UnknownHostException - if the IP address of the target host can not be determined
ConnectTimeoutException - if the socket cannot be connected within the time limit defined in the params

isSecure

public boolean isSecure(java.net.Socket sock)
                 throws java.lang.IllegalArgumentException
Checks whether a socket connection is secure. This factory creates TLS/SSL socket connections which, by default, are considered secure.
Derived classes may override this method to perform runtime checks, for example based on the cypher suite.

Specified by:
isSecure in interface SocketFactory
Parameters:
sock - the connected socket
Returns:
true
Throws:
java.lang.IllegalArgumentException - if the argument is invalid

createSocket

public java.net.Socket createSocket(java.net.Socket socket,
                                    java.lang.String host,
                                    int port,
                                    boolean autoClose)
                             throws java.io.IOException,
                                    java.net.UnknownHostException
Description copied from interface: LayeredSocketFactory
Returns a socket connected to the given host that is layered over an existing socket. Used primarily for creating secure sockets through proxies.

Specified by:
createSocket in interface LayeredSocketFactory
Parameters:
socket - the existing socket
host - the host name/IP
port - the port on the host
autoClose - a flag for closing the underling socket when the created socket is closed
Returns:
Socket a new socket
Throws:
java.io.IOException - if an I/O error occurs while creating the socket
java.net.UnknownHostException - if the IP address of the host cannot be determined

setHostnameVerifier

public void setHostnameVerifier(X509HostnameVerifier hostnameVerifier)

getHostnameVerifier

public X509HostnameVerifier getHostnameVerifier()


Copyright © 1999-2008 Apache Software Foundation. All Rights Reserved.