org.ektorp.http
Class AndroidSSLSocketFactory

java.lang.Object
  org.ektorp.http.AndroidSSLSocketFactory

All Implemented Interfaces:

org.apache.http.conn.scheme.LayeredSocketFactory, org.apache.http.conn.scheme.SocketFactory

public class AndroidSSLSocketFactory
extends java.lang.Object
implements org.apache.http.conn.scheme.LayeredSocketFactory, org.apache.http.conn.scheme.SocketFactory

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

• Use JDK keytool utility to generate a new key

  keytool -genkey -v -alias "my client key" -validity 365 -keystore my.keystore

  For simplicity use the same password for the key as that of the keystore

• Issue a certificate signing request (CSR)

  keytool -certreq -alias "my client key" -file mycertreq.csr -keystore my.keystore

• Send the certificate request to the trusted Certificate Authority for signature. One may choose to act as her own CA and sign the certificate request using a PKI tool, such as OpenSSL.

• Import the trusted CA root certificate

  keytool -import -alias "my trusted ca" -file caroot.crt -keystore my.keystore

• Import the PKCS#7 file containg the complete certificate chain

  keytool -import -alias "my client key" -file mycert.p7 -keystore my.keystore

• Verify the content the resultant keystore file

  keytool -list -v -keystore my.keystore

Author:

Oleg Kalnichevski, Julius Davies

Field Summary

static org.apache.http.conn.ssl.X509HostnameVerifier	ALLOW_ALL_HOSTNAME_VERIFIER
static org.apache.http.conn.ssl.X509HostnameVerifier	BROWSER_COMPATIBLE_HOSTNAME_VERIFIER
static java.lang.String	SSL
static java.lang.String	SSLV2
static org.apache.http.conn.ssl.X509HostnameVerifier	STRICT_HOSTNAME_VERIFIER
static java.lang.String	TLS
static javax.net.ssl.TrustManager	TRUST_EVEYONE_MANAGER

Constructor Summary

AndroidSSLSocketFactory(java.security.KeyStore truststore)

AndroidSSLSocketFactory(java.security.KeyStore keystore, java.lang.String keystorePassword)

AndroidSSLSocketFactory(java.security.KeyStore keystore, java.lang.String keystorePassword, java.security.KeyStore truststore)

AndroidSSLSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory)
Constructs an HttpClient SSLSocketFactory backed by the given JSSE SSLSocketFactory.

AndroidSSLSocketFactory(java.lang.String algorithm, java.security.KeyStore keystore, java.lang.String keystorePassword, java.security.KeyStore truststore, java.security.SecureRandom random, org.apache.http.conn.scheme.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)
java.net.Socket	createSocket()
java.net.Socket	createSocket(java.net.Socket socket, java.lang.String host, int port, boolean autoClose)
org.apache.http.conn.ssl.X509HostnameVerifier	getHostnameVerifier()
static AndroidSSLSocketFactory	getSocketFactory() Gets an singleton instance of the SSLProtocolSocketFactory.
boolean	isSecure(java.net.Socket sock) Checks whether a socket connection is secure.
void	setHostnameVerifier(org.apache.http.conn.ssl.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 org.apache.http.conn.ssl.X509HostnameVerifier ALLOW_ALL_HOSTNAME_VERIFIER

BROWSER_COMPATIBLE_HOSTNAME_VERIFIER

public static final org.apache.http.conn.ssl.X509HostnameVerifier BROWSER_COMPATIBLE_HOSTNAME_VERIFIER

STRICT_HOSTNAME_VERIFIER

public static final org.apache.http.conn.ssl.X509HostnameVerifier STRICT_HOSTNAME_VERIFIER

TRUST_EVEYONE_MANAGER

public static final javax.net.ssl.TrustManager TRUST_EVEYONE_MANAGER

Constructor Detail

AndroidSSLSocketFactory

public AndroidSSLSocketFactory(java.lang.String algorithm,
                               java.security.KeyStore keystore,
                               java.lang.String keystorePassword,
                               java.security.KeyStore truststore,
                               java.security.SecureRandom random,
                               org.apache.http.conn.scheme.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

AndroidSSLSocketFactory

public AndroidSSLSocketFactory(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

AndroidSSLSocketFactory

public AndroidSSLSocketFactory(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

AndroidSSLSocketFactory

public AndroidSSLSocketFactory(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

AndroidSSLSocketFactory

public AndroidSSLSocketFactory(javax.net.ssl.SSLSocketFactory socketfactory)

Constructs an HttpClient SSLSocketFactory backed by the given JSSE SSLSocketFactory.

Method Detail

getSocketFactory

public static AndroidSSLSocketFactory getSocketFactory()

Gets an singleton instance of the SSLProtocolSocketFactory.

Returns:

a SSLProtocolSocketFactory

createSocket

public java.net.Socket createSocket()
                             throws java.io.IOException

Specified by:

createSocket in interface org.apache.http.conn.scheme.SocketFactory

Throws:

java.io.IOException

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

Specified by:

connectSocket in interface org.apache.http.conn.scheme.SocketFactory

Throws:

java.io.IOException

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 org.apache.http.conn.scheme.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

Specified by:

createSocket in interface org.apache.http.conn.scheme.LayeredSocketFactory

Throws:

java.io.IOException

java.net.UnknownHostException

setHostnameVerifier

public void setHostnameVerifier(org.apache.http.conn.ssl.X509HostnameVerifier hostnameVerifier)

getHostnameVerifier

public org.apache.http.conn.ssl.X509HostnameVerifier getHostnameVerifier()